RetrieveMediaWidget

Complexity

Total Complexity

27

Size/Duplication

Total Lines	244
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	7

Importance

Changes

0

13 Methods

Rating	Name	Duplication	Size	Complexity
A	renderWatchInBrowserButton()	0	13	1
A	checkLinks()	0	7	3
A	renderWatchButton()	0	11	1
A	getLoggableLinkOptions()	0	6	1
A	renderMissingFile()	0	4	1
A	renderPlayOnBackendLink()	0	6	1
A	renderForm()	0	34	4
A	init()	0	3	1
A	renderLinks()	0	26	4
A	getStreamUrl()	0	9	5
A	getDownloadName()	0	3	1
A	run()	0	14	3
A	getWatchButtonsOptions()	0	7	1

<?php

/**
 * Base class for rendering a watch button and links to media items
 *
 * @author Sam Stenvall <neggelandia@gmail.com>
 * @copyright Copyright &copy; Sam Stenvall 2013-
 * @license https://www.gnu.org/licenses/gpl.html The GNU General Public License v3.0
 */
abstract class RetrieveMediaWidget extends CWidget
{

	/**
	 * @var string the type of media that the links are for
	 */
	public $type;

	/**
	 * @var File the media file
	 */
	public $details;
	
	/**
	 * @var ItemLink[] the media links
	 */
	private $_links;
	
	/**
	 * @return string the category to use when logging download link clicks
	 */
	abstract protected function getLogMessage();
	
	/**
	 * @return array the action for retrieving an item's playlist (as a single 
	 * item array)
	 */
	abstract protected function getPlayListAction();
	
	/**
	 * Initializes the widget
	 */
	public function init()
	{
		$this->_links = $this->details->getItemLinks();
	}

	/**
	 * Runs the widget
	 */
	public function run()
	{
		// Don't render links for spectators
		if (Yii::app()->user->role === User::ROLE_SPECTATOR)
			return;
		
		if (!$this->checkLinks())
		{
			$this->renderMissingFile();

			return;
		}
		
		$this->renderForm();
	}

	/**
	 * Checks that all media links are valid
	 * @return boolean
	 */
	private function checkLinks()
	{
		foreach ($this->_links as $link)
			if (!$link->url)
				return false;

		return true;
	}
	
	/**
	 * @param string $link
	 * @return string the filename part of the full link to a file
	 */
	private function getDownloadName($link)
	{
		return urldecode(substr($link, strrpos($link, '%2f') + 3));
	}

	/**
	 * Returns the stream URL for the media. A direct link will be returned if 
	 * the user is on a mobile device or if the "singleFilePlaylist" setting 
	 * is enabled, otherwise the media playlist URL will be returned
	 * @return string the stream URL
	 */
	protected function getStreamUrl()
	{
		if (count($this->_links) === 1 && (Setting::getBoolean('singleFilePlaylist') 
				|| (Browser::isMobile() || Browser::isTablet())))
		{
			return $this->_links[0]->url;
		}
		else
			return $this->getPlayListAction();

The expression return $this->getPlayListAction() returns the type array which is incompatible with the documented return type string.

	}
	
	/**
	 * @return array options for the watch buttons displayed
	 */
	private function getWatchButtonsOptions()
	{
		return array(
			'color'=>TbHtml::BUTTON_COLOR_SUCCESS,
			'size'=>TbHtml::BUTTON_SIZE_LARGE,
			'url'=>$this->getStreamUrl(),
			'class'=>'fa fa-file-movie-o');
	}
	
	/**
	 * Renders the form that contains the buttons and links to watch/download 
	 * and item
	 */
	private function renderForm()
	{
		// Render the form with all the retrieval options
		echo CHtml::beginForm($this->getPlayListAction(), 'get');
		echo CHtml::hiddenField('id', $this->details->getId());
		
		// Show the "Play in browser" button when applicable
		$helper = new MediaInfoHelper($this->details);
		
		if (!$helper->needsTranscoding() && count($this->_links) === 1)
		{
			?>
			<section>
				<?php $this->renderWatchInBrowserButton(); ?>
			</section>
			<?php
		}
		
		// Show the "Watch as playlist" button if the file is streamable, 
		// otherwise show an alert
		if ($helper->isStreamable())
		{
			?>
			<section>
				<?php $this->renderWatchButton(); ?>
			</section>
			<?php
		}
		else
			$this->renderMissingFile();
		
		// Render the download links and close the form
		$this->renderLinks();
		echo CHtml::endForm();
	}

	/**
	 * Renders the download links
	 */
	private function renderLinks()
	{
		echo CHtml::openTag('div', array('class'=>'item-links'));

		$numLinks = count($this->_links);
		$linkOptions = array_merge(array(
			'class'=>'fa fa-floppy-o loggable-link'), $this->getLoggableLinkOptions());

		foreach ($this->_links as $k=> $link)
		{
			if ($numLinks == 1)
				$label = Yii::t('RetrieveMediaWidget', 'Download');
			else
				$label = Yii::t('RetrieveMediaWidget', 'Download (part #{partNumber})', array('{partNumber}'=>++$k));

			// Add the "download" attribute
			$linkOptions['download'] = $this->getDownloadName($link->url);
			
			echo CHtml::tag('p', array(), CHtml::link($label, $link->url, $linkOptions));
		}
		
		// Show a "Play in XBMC" link to administrators
		if (Yii::app()->user->role === User::ROLE_ADMIN)
			$this->renderPlayOnBackendLink();

		echo CHtml::closeTag('div');
	}
	
	/**
	 * Renders a warning about a missing file
	 */
	private function renderMissingFile()
	{
		echo CHtml::tag('p', array('class'=>'missing-video-file'), TbHtml::icon(TBHtml::ICON_WARNING_SIGN).
					Yii::t('RetrieveMediaWidget', 'The file(s) for this item is not available'));
	}
	
	/**
	 * Renders the "Play in XBMC" link
	 */
	private function renderPlayOnBackendLink()
	{
		echo CHtml::tag('p', array(), CHtml::link(
				Yii::t('RetrieveMediaWidget', 'Play in XBMC'), 
				array('playOnBackend', 'file'=>$this->details->file), 
				array('class'=>'fa fa-desktop'))); 
	}

	/**
	 * Renders the "Watch as playlist" button
	 */
	private function renderWatchButton()
	{
		// Select the default playlist format by default
		$dropdownOptions = array(
			Setting::getString('playlistFormat')=>array('selected'=>'selected'));

		echo TbHtml::dropDownListControlGroup('playlistFormat', 'playlistFormat', PlaylistFactory::getTypes(), array(
			'label'=>Yii::t('Settings', 'Playlist format'),
			'options'=>$dropdownOptions));

		echo TbHtml::submitButton(Yii::t('RetrieveMediaWidget', 'Watch as playlist'), $this->getWatchButtonsOptions());
	}
	
	/**
	 * Renders the "Watch as in browser" button
	 */
	private function renderWatchInBrowserButton()
	{
		// Swap the button URL for the first item link
		$buttonOptions = $this->getWatchButtonsOptions();
		$buttonOptions['class'] = 'fa fa-play';
		$buttonOptions['color'] = TbHtml::BUTTON_COLOR_PRIMARY;
		$buttonOptions['url'] = array('watchInBrowser', 'url'=>$this->_links[0]->url);
		
		// Add logging
		TbHtml::addCssClass('loggable-link', $buttonOptions);
		$buttonOptions = array_merge($buttonOptions, $this->getLoggableLinkOptions());
		
		echo TbHtml::linkButton(Yii::t('RetrieveMediaWidget', 'Watch in browser'), $buttonOptions);
	}
	
	/**
	 * @return array HTML options for loggable links
	 */
	private function getLoggableLinkOptions()
	{
		return array(
			'data-log-category'=>get_class(Yii::app()->controller),
			'data-log-message'=>htmlentities($this->getLogMessage()),
			'data-log-url'=>Yii::app()->controller->createUrl('/log/logEvent'));
	}

}