162 lines
6.4 KiB
PHP
162 lines
6.4 KiB
PHP
<?php
|
|
|
|
/**
|
|
* (c) Kitodo. Key to digital objects e.V. <contact@kitodo.org>
|
|
*
|
|
* This file is part of the Kitodo and TYPO3 projects.
|
|
*
|
|
* @license GNU General Public License version 3 or later.
|
|
* For the full copyright and license information, please read the
|
|
* LICENSE.txt file that was distributed with this source code.
|
|
*/
|
|
|
|
namespace Kitodo\Dlf\Plugin;
|
|
|
|
use TYPO3\CMS\Core\Page\PageRenderer;
|
|
use TYPO3\CMS\Core\Utility\ExtensionManagementUtility;
|
|
use TYPO3\CMS\Core\Utility\GeneralUtility;
|
|
use TYPO3\CMS\Core\Utility\MathUtility;
|
|
use TYPO3\CMS\Core\Utility\PathUtility;
|
|
|
|
/**
|
|
* Plugin AudioPlayer for the 'dlf' extension
|
|
*
|
|
* @author Sebastian Meyer <sebastian.meyer@slub-dresden.de>
|
|
* @package TYPO3
|
|
* @subpackage dlf
|
|
* @access public
|
|
*/
|
|
class AudioPlayer extends \Kitodo\Dlf\Common\AbstractPlugin
|
|
{
|
|
public $scriptRelPath = 'Classes/Plugin/AudioPlayer.php';
|
|
|
|
/**
|
|
* Holds the current audio file's URL, MIME type and optional label
|
|
*
|
|
* @var array
|
|
* @access protected
|
|
*/
|
|
protected $audio = [];
|
|
|
|
/**
|
|
* Adds Player javascript
|
|
*
|
|
* @access protected
|
|
*
|
|
* @return string The output string for the ###JAVASCRIPT### template marker
|
|
*/
|
|
protected function addPlayerJS()
|
|
{
|
|
$markerArray = '';
|
|
// CSS files.
|
|
$cssFiles = [
|
|
'Resources/Public/Javascript/jPlayer/blue.monday/css/jplayer.blue.monday.min.css'
|
|
];
|
|
// Inline CSS.
|
|
$inlineCSS = '#tx-dlf-audio { width: 100px; height: 100px; }';
|
|
//Javascript files.
|
|
$jsFiles = [
|
|
// jPlayer
|
|
'Resources/Public/Javascript/jPlayer/jquery.jplayer.min.js',
|
|
// AudioPlayer
|
|
'Resources/Public/Javascript/AudioPlayer/AudioPlayer.js'
|
|
];
|
|
// AudioPlayer configuration.
|
|
$audioplayerConfiguration = '
|
|
$(document).ready(function() {
|
|
AudioPlayer = new dlfAudioPlayer({
|
|
audio: {
|
|
mimeType: "' . $this->audio['mimetype'] . '",
|
|
title: "' . $this->audio['label'] . '",
|
|
url: "' . $this->audio['url'] . '"
|
|
},
|
|
parentElId: "tx-dlf-audio",
|
|
swfPath: "' . PathUtility::stripPathSitePrefix(ExtensionManagementUtility::extPath($this->extKey)) . 'Resources/Public/Javascript/jPlayer/jquery.jplayer.swf"
|
|
});
|
|
});
|
|
';
|
|
// Add Javascript to page footer if not configured otherwise.
|
|
if (empty($this->conf['addJStoBody'])) {
|
|
$pageRenderer = GeneralUtility::makeInstance(PageRenderer::class);
|
|
foreach ($cssFiles as $cssFile) {
|
|
$pageRenderer->addCssFile(PathUtility::stripPathSitePrefix(ExtensionManagementUtility::extPath($this->extKey)) . $cssFile);
|
|
}
|
|
$pageRenderer->addCssInlineBlock('kitodo-audioplayer-configuration', $inlineCSS);
|
|
foreach ($jsFiles as $jsFile) {
|
|
$pageRenderer->addJsFooterFile(PathUtility::stripPathSitePrefix(ExtensionManagementUtility::extPath($this->extKey)) . $jsFile);
|
|
}
|
|
$pageRenderer->addJsFooterInlineCode('kitodo-audioplayer-configuration', $audioplayerConfiguration);
|
|
} else {
|
|
foreach ($jsFiles as $jsFile) {
|
|
$markerArray .= '<script type="text/javascript" src="' . PathUtility::stripPathSitePrefix(ExtensionManagementUtility::extPath($this->extKey)) . $jsFile . '"></script>' . "\n";
|
|
}
|
|
$markerArray .= '
|
|
<script type="text/javascript">
|
|
/*<![CDATA[*/
|
|
/*kitodo-audioplayer-configuration*/
|
|
' . $audioplayerConfiguration . '
|
|
/*]]>*/
|
|
</script>';
|
|
}
|
|
return $markerArray;
|
|
}
|
|
|
|
/**
|
|
* The main method of the PlugIn
|
|
*
|
|
* @access public
|
|
*
|
|
* @param string $content: The PlugIn content
|
|
* @param array $conf: The PlugIn configuration
|
|
*
|
|
* @return string The content that is displayed on the website
|
|
*/
|
|
public function main($content, $conf)
|
|
{
|
|
$this->init($conf);
|
|
// Load current document.
|
|
$this->loadDocument();
|
|
if (
|
|
$this->doc === null
|
|
|| $this->doc->numPages < 1
|
|
) {
|
|
// Quit without doing anything if required variables are not set.
|
|
return $content;
|
|
} else {
|
|
// Set default values if not set.
|
|
// $this->piVars['page'] may be integer or string (physical structure @ID)
|
|
if (
|
|
(int) $this->piVars['page'] > 0
|
|
|| empty($this->piVars['page'])
|
|
) {
|
|
$this->piVars['page'] = MathUtility::forceIntegerInRange((int) $this->piVars['page'], 1, $this->doc->numPages, 1);
|
|
} else {
|
|
$this->piVars['page'] = array_search($this->piVars['page'], $this->doc->physicalStructure);
|
|
}
|
|
$this->piVars['double'] = MathUtility::forceIntegerInRange($this->piVars['double'], 0, 1, 0);
|
|
}
|
|
// Check if there are any audio files available.
|
|
$fileGrpsAudio = GeneralUtility::trimExplode(',', $this->conf['fileGrpAudio']);
|
|
while ($fileGrpAudio = array_shift($fileGrpsAudio)) {
|
|
if (!empty($this->doc->physicalStructureInfo[$this->doc->physicalStructure[$this->piVars['page']]]['files'][$fileGrpAudio])) {
|
|
// Get audio data.
|
|
$this->audio['url'] = $this->doc->getFileLocation($this->doc->physicalStructureInfo[$this->doc->physicalStructure[$this->piVars['page']]]['files'][$fileGrpAudio]);
|
|
$this->audio['label'] = $this->doc->physicalStructureInfo[$this->doc->physicalStructure[$this->piVars['page']]]['label'];
|
|
$this->audio['mimetype'] = $this->doc->getFileMimeType($this->doc->physicalStructureInfo[$this->doc->physicalStructure[$this->piVars['page']]]['files'][$fileGrpAudio]);
|
|
break;
|
|
}
|
|
}
|
|
if (!empty($this->audio)) {
|
|
// Add jPlayer javascript.
|
|
$markerArray['###JAVASCRIPT###'] = $this->addPlayerJS();
|
|
} else {
|
|
// Quit without doing anything if required variables are not set.
|
|
return $content;
|
|
}
|
|
// Load template file.
|
|
$this->getTemplate();
|
|
$content .= $this->templateService->substituteMarkerArray($this->template, $markerArray);
|
|
return $this->pi_wrapInBaseClass($content);
|
|
}
|
|
}
|