vendor/pimcore/pimcore/models/Document/Editable/Video.php line 27

Open in your IDE?
  1. <?php
  3. /**
  4. * Pimcore
  5. *
  6. * This source file is available under two different licenses:
  7. * - GNU General Public License version 3 (GPLv3)
  8. * - Pimcore Commercial License (PCL)
  9. * Full copyright and license information is available in
  10. * LICENSE.md which is distributed with this source code.
  11. *
  12. * @copyright Copyright (c) Pimcore GmbH (http://www.pimcore.org)
  13. * @license http://www.pimcore.org/license GPLv3 and PCL
  14. */
  16. namespace Pimcore\Model\Document\Editable;
  18. use Pimcore\Bundle\CoreBundle\EventListener\Frontend\FullPageCacheListener;
  19. use Pimcore\Logger;
  20. use Pimcore\Model;
  21. use Pimcore\Model\Asset;
  22. use Pimcore\Tool;
  24. /**
  25. * @method \Pimcore\Model\Document\Editable\Dao getDao()
  26. */
  27. class Video extends Model\Document\Editable implements IdRewriterInterface
  28. {
  29. public const TYPE_ASSET = 'asset';
  31. public const TYPE_YOUTUBE = 'youtube';
  33. public const TYPE_VIMEO = 'vimeo';
  35. public const TYPE_DAILYMOTION = 'dailymotion';
  37. public const ALLOWED_TYPES = [
  38. self::TYPE_ASSET,
  39. self::TYPE_YOUTUBE,
  40. self::TYPE_VIMEO,
  41. self::TYPE_DAILYMOTION,
  42. ];
  44. /**
  45. * contains depending on the type of the video the unique identifier eg. "http://www.youtube.com", "789", ...
  46. *
  47. * @internal
  48. *
  49. * @var int|string|null
  50. */
  51. protected $id;
  53. /**
  54. * one of self::ALLOWED_TYPES
  55. *
  56. * @internal
  57. *
  58. * @var string|null
  59. */
  60. protected $type;
  62. /**
  63. * asset ID of poster image
  64. *
  65. * @internal
  66. *
  67. * @var int|null
  68. */
  69. protected $poster;
  71. /**
  72. * @internal
  73. *
  74. * @var string
  75. */
  76. protected $title = '';
  78. /**
  79. * @internal
  80. *
  81. * @var string
  82. */
  83. protected $description = '';
  85. /**
  86. * @internal
  87. *
  88. * @var array|null
  89. */
  90. protected $allowedTypes;
  92. /**
  93. * @param int|string|null $id
  94. *
  95. * @return $this
  96. */
  97. public function setId($id)
  98. {
  99. $this->id = $id;
  101. return $this;
  102. }
  104. /**
  105. * @return int|string|null
  106. */
  107. public function getId()
  108. {
  109. return $this->id;
  110. }
  112. /**
  113. * @param string $title
  114. *
  115. * @return $this
  116. */
  117. public function setTitle($title)
  118. {
  119. $this->title = $title;
  121. return $this;
  122. }
  124. /**
  125. * @return string
  126. */
  127. public function getTitle()
  128. {
  129. if (!$this->title && $this->getVideoAsset()) {
  130. // default title for microformats
  131. return $this->getVideoAsset()->getFilename();
  132. }
  134. return $this->title;
  135. }
  137. /**
  138. * @param string $description
  139. *
  140. * @return $this
  141. */
  142. public function setDescription($description)
  143. {
  144. $this->description = $description;
  146. return $this;
  147. }
  149. /**
  150. * @return string
  151. */
  152. public function getDescription()
  153. {
  154. if (!$this->description) {
  155. // default description for microformats
  156. return $this->getTitle();
  157. }
  159. return $this->description;
  160. }
  162. /**
  163. * @param int|null $id
  164. *
  165. * @return $this
  166. */
  167. public function setPoster($id)
  168. {
  169. $this->poster = $id;
  171. return $this;
  172. }
  174. /**
  175. * @return int|null
  176. */
  177. public function getPoster()
  178. {
  179. return $this->poster;
  180. }
  182. /**
  183. * @param string $type
  184. *
  185. * @return $this
  186. */
  187. public function setType($type)
  188. {
  189. $this->type = $type;
  191. return $this;
  192. }
  194. /**
  195. * {@inheritdoc}
  196. */
  197. public function getType()
  198. {
  199. return 'video';
  200. }
  202. /**
  203. * @param array $allowedTypes
  204. *
  205. * @return $this
  206. */
  207. public function setAllowedTypes($allowedTypes)
  208. {
  209. $this->allowedTypes = $allowedTypes;
  211. return $this;
  212. }
  214. /**
  215. * @return array
  216. */
  217. public function getAllowedTypes()
  218. {
  219. if ($this->allowedTypes === null) {
  220. $this->updateAllowedTypesFromConfig($this->getConfig());
  221. }
  223. return $this->allowedTypes;
  224. }
  226. /**
  227. * {@inheritdoc}
  228. */
  229. public function getData()
  230. {
  231. $path = $this->id;
  232. if ($this->type === self::TYPE_ASSET && ($video = Asset::getById($this->id))) {
  233. $path = $video->getFullPath();
  234. }
  236. $allowedTypes = $this->getAllowedTypes();
  238. if (
  239. empty($this->type) === true
  240. || in_array($this->type, $allowedTypes, true) === false
  241. ) {
  242. // Set the first type in array as default selection for dropdown
  243. $this->type = $allowedTypes[0];
  245. // Reset "id" and "path" to prevent invalid references
  246. $this->id = '';
  247. $path = '';
  248. }
  250. $poster = Asset::getById($this->poster);
  252. return [
  253. 'id' => $this->id,
  254. 'type' => $this->type,
  255. 'allowedTypes' => $allowedTypes,
  256. 'title' => $this->title,
  257. 'description' => $this->description,
  258. 'path' => $path,
  259. 'poster' => $poster ? $poster->getFullPath() : '',
  260. ];
  261. }
  263. /**
  264. * @return mixed
  265. */
  266. protected function getDataEditmode()
  267. {
  268. $data = $this->getData();
  270. $poster = Asset::getById($this->poster);
  271. if ($poster) {
  272. $data['poster'] = $poster->getRealFullPath();
  273. }
  275. if ($this->type === self::TYPE_ASSET && ($video = Asset::getById($this->id))) {
  276. $data['path'] = $video->getRealFullPath();
  277. }
  279. return $data;
  280. }
  282. /**
  283. * {@inheritdoc}
  284. */
  285. public function getDataForResource()
  286. {
  287. return [
  288. 'id' => $this->id,
  289. 'type' => $this->type,
  290. 'allowedTypes' => $this->getAllowedTypes(),
  291. 'title' => $this->title,
  292. 'description' => $this->description,
  293. 'poster' => $this->poster,
  294. ];
  295. }
  297. /**
  298. * {@inheritdoc}
  299. */
  300. public function frontend()
  301. {
  302. $inAdmin = false;
  303. $args = func_get_args();
  304. if (array_key_exists(0, $args)) {
  305. $inAdmin = $args[0];
  306. }
  308. if (
  309. empty($this->id) === true
  310. || empty($this->type) === true
  311. || in_array($this->type, $this->getAllowedTypes(), true) === false
  312. ) {
  313. return $this->getEmptyCode();
  314. } elseif ($this->type === self::TYPE_ASSET) {
  315. return $this->getAssetCode($inAdmin);
  316. } elseif ($this->type === self::TYPE_YOUTUBE) {
  317. return $this->getYoutubeCode($inAdmin);
  318. } elseif ($this->type === self::TYPE_VIMEO) {
  319. return $this->getVimeoCode($inAdmin);
  320. } elseif ($this->type === self::TYPE_DAILYMOTION) {
  321. return $this->getDailymotionCode($inAdmin);
  322. } elseif ($this->type === 'url') {
  323. return $this->getUrlCode();
  324. }
  326. return $this->getEmptyCode();
  327. }
  329. /**
  330. * {@inheritdoc}
  331. */
  332. public function resolveDependencies()
  333. {
  334. $dependencies = [];
  336. if ($this->type === self::TYPE_ASSET) {
  337. $asset = Asset::getById($this->id);
  338. if ($asset instanceof Asset) {
  339. $key = 'asset_' . $asset->getId();
  340. $dependencies[$key] = [
  341. 'id' => $asset->getId(),
  342. 'type' => self::TYPE_ASSET,
  343. ];
  344. }
  345. }
  347. if ($poster = Asset::getById($this->poster)) {
  348. $key = 'asset_' . $poster->getId();
  349. $dependencies[$key] = [
  350. 'id' => $poster->getId(),
  351. 'type' => self::TYPE_ASSET,
  352. ];
  353. }
  355. return $dependencies;
  356. }
  358. /**
  359. * {@inheritdoc}
  360. */
  361. public function checkValidity()
  362. {
  363. $valid = true;
  364. if ($this->type === self::TYPE_ASSET && !empty($this->id)) {
  365. $el = Asset::getById($this->id);
  366. if (!$el instanceof Asset) {
  367. $valid = false;
  368. Logger::notice('Detected invalid relation, removing reference to non existent asset with id ['.$this->id.']');
  369. $this->id = null;
  370. $this->type = null;
  371. }
  372. }
  374. if (!($poster = Asset::getById($this->poster))) {
  375. $valid = false;
  376. Logger::notice('Detected invalid relation, removing reference to non existent asset with id ['.$this->id.']');
  377. $this->poster = null;
  378. }
  380. return $valid;
  381. }
  383. /**
  384. * {@inheritdoc}
  385. */
  386. public function admin()
  387. {
  388. $html = parent::admin();
  390. // get frontendcode for preview
  391. // put the video code inside the generic code
  392. $html = str_replace('</div>', $this->frontend(true) . '</div>', $html);
  394. return $html;
  395. }
  397. /**
  398. * {@inheritdoc}
  399. */
  400. public function setDataFromResource($data)
  401. {
  402. if (!empty($data)) {
  403. $data = \Pimcore\Tool\Serialize::unserialize($data);
  404. }
  406. $this->id = $data['id'];
  407. $this->type = $data['type'];
  408. $this->poster = $data['poster'];
  409. $this->title = $data['title'];
  410. $this->description = $data['description'];
  412. return $this;
  413. }
  415. /**
  416. * {@inheritdoc}
  417. */
  418. public function setDataFromEditmode($data)
  419. {
  420. if (isset($data['type'])
  421. && in_array($data['type'], self::ALLOWED_TYPES, true) === true
  422. ) {
  423. $this->type = $data['type'];
  424. }
  426. if (isset($data['title'])) {
  427. $this->title = $data['title'];
  428. }
  430. if (isset($data['description'])) {
  431. $this->description = $data['description'];
  432. }
  434. // this is to be backward compatible to <= v 1.4.7
  435. if (isset($data['id']) && $data['id']) {
  436. $data['path'] = $data['id'];
  437. }
  439. $video = Asset::getByPath($data['path']);
  440. if ($video instanceof Asset\Video) {
  441. $this->id = $video->getId();
  442. } else {
  443. $this->id = $data['path'];
  444. }
  446. $this->poster = null;
  447. $poster = Asset::getByPath($data['poster']);
  448. if ($poster instanceof Asset\Image) {
  449. $this->poster = $poster->getId();
  450. }
  452. return $this;
  453. }
  455. /**
  456. * @return int|string
  457. */
  458. public function getWidth()
  459. {
  460. return $this->getConfig()['width'] ?? '100%';
  461. }
  463. /**
  464. * @return string
  465. */
  466. private function getWidthWithUnit()
  467. {
  468. $width = $this->getWidth();
  470. if (is_numeric($width)) {
  471. $width .= 'px';
  472. }
  474. return $width;
  475. }
  477. /**
  478. * @return string
  479. */
  480. private function getHeightWithUnit()
  481. {
  482. $height = $this->getHeight();
  484. if (is_numeric($height)) {
  485. $height .= 'px';
  486. }
  488. return $height;
  489. }
  491. /**
  492. * @return int|string
  493. */
  494. public function getHeight()
  495. {
  496. return $this->getConfig()['height'] ?? 300;
  497. }
  499. private function getAssetCode(bool $inAdmin = false): string
  500. {
  501. $asset = Asset::getById($this->id);
  502. $config = $this->getConfig();
  503. $thumbnailConfig = $config['thumbnail'] ?? null;
  505. // compatibility mode when FFMPEG is not present or no thumbnail config is given
  506. if (!\Pimcore\Video::isAvailable() || !$thumbnailConfig) {
  507. if ($asset instanceof Asset\Video && preg_match("/\.(f4v|flv|mp4)/i", $asset->getFullPath())) {
  508. $image = $this->getPosterThumbnailImage($asset);
  510. return $this->getHtml5Code(['mp4' => (string) $asset], $image);
  511. }
  513. return $this->getErrorCode('Asset is not a video, or missing thumbnail configuration');
  514. }
  516. if ($asset instanceof Asset\Video) {
  517. $thumbnail = $asset->getThumbnail($thumbnailConfig);
  518. if ($thumbnail) {
  519. $image = $this->getPosterThumbnailImage($asset);
  521. if ($inAdmin && isset($config['editmodeImagePreview']) && $config['editmodeImagePreview']) {
  522. $code = '<div id="pimcore_video_' . $this->getName() . '" class="pimcore_editable_video '. ($config['class'] ?? '') .'">';
  523. $code .= '<img width="' . $this->getWidth() . '" src="' . $image . '" />';
  524. $code .= '</div>';
  526. return $code;
  527. }
  529. if ($thumbnail['status'] === 'finished') {
  530. return $this->getHtml5Code($thumbnail['formats'], $image);
  531. }
  533. if ($thumbnail['status'] === 'inprogress') {
  534. // disable the output-cache if enabled
  535. $cacheService = \Pimcore::getContainer()->get(FullPageCacheListener::class);
  536. $cacheService->disable('Video rendering in progress');
  538. return $this->getProgressCode($image);
  539. }
  541. return $this->getErrorCode('The video conversion failed, please see the log files in /var/log for more details.');
  542. }
  544. return $this->getErrorCode("The given thumbnail doesn't exist: '" . $thumbnailConfig . "'");
  545. }
  547. return $this->getEmptyCode();
  548. }
  550. /**
  551. * @return Asset\Image\Thumbnail|Asset\Video\ImageThumbnail
  552. */
  553. private function getPosterThumbnailImage(Asset\Video $asset)
  554. {
  555. $config = $this->getConfig();
  556. if (!array_key_exists('imagethumbnail', $config) || empty($config['imagethumbnail'])) {
  557. $thumbnailConfig = $asset->getThumbnailConfig($config['thumbnail'] ?? null);
  559. if ($thumbnailConfig instanceof Asset\Video\Thumbnail\Config) {
  560. // try to get the dimensions out ouf the video thumbnail
  561. $imageThumbnailConf = $thumbnailConfig->getEstimatedDimensions();
  562. $imageThumbnailConf['format'] = 'JPEG';
  563. }
  564. } else {
  565. $imageThumbnailConf = $config['imagethumbnail'];
  566. }
  568. if (empty($imageThumbnailConf)) {
  569. $imageThumbnailConf['width'] = 800;
  570. $imageThumbnailConf['format'] = 'JPEG';
  571. }
  573. if ($this->poster && ($poster = Asset\Image::getById($this->poster))) {
  574. return $poster->getThumbnail($imageThumbnailConf);
  575. }
  576. if (
  577. $asset->getCustomSetting('image_thumbnail_asset') &&
  578. ($customPreviewAsset = Asset\Image::getById($asset->getCustomSetting('image_thumbnail_asset')))
  579. ) {
  580. return $customPreviewAsset->getThumbnail($imageThumbnailConf);
  581. }
  583. return $asset->getImageThumbnail($imageThumbnailConf);
  584. }
  586. /**
  587. * @return string
  588. */
  589. private function getUrlCode()
  590. {
  591. return $this->getHtml5Code(['mp4' => (string) $this->id]);
  592. }
  594. /**
  595. * @param string $message
  596. *
  597. * @return string
  598. */
  599. private function getErrorCode($message = '')
  600. {
  601. $width = $this->getWidth();
  602. // If contains at least one digit (0-9), then assume it is a value that can be calculated,
  603. // otherwise it is likely be `auto`,`inherit`,etc..
  604. if (preg_match('/[\d]/', $width)) {
  605. // when is numeric, assume there are no length units nor %, and considering the value as pixels
  606. if (is_numeric($width)) {
  607. $width .= 'px';
  608. }
  609. $width = 'calc(' . $width . ' - 1px)';
  610. }
  612. $height = $this->getHeight();
  613. if (preg_match('/[\d]/', $height)) {
  614. if (is_numeric($height)) {
  615. $height .= 'px';
  616. }
  617. $height = 'calc(' . $height . ' - 1px)';
  618. }
  620. // only display error message in debug mode
  621. if (!\Pimcore::inDebugMode()) {
  622. $message = '';
  623. }
  625. $code = '
  626. <div id="pimcore_video_' . $this->getName() . '" class="pimcore_editable_video">
  627. <div class="pimcore_editable_video_error" style="text-align:center; width: ' . $width . '; height: ' . $height . '; border:1px solid #000; background: url(/bundles/pimcoreadmin/img/filetype-not-supported.svg) no-repeat center center #fff;">
  628. ' . $message . '
  629. </div>
  630. </div>';
  632. return $code;
  633. }
  635. /**
  636. * @return string
  637. */
  638. private function parseYoutubeId()
  639. {
  640. $youtubeId = '';
  641. if ($this->type === self::TYPE_YOUTUBE) {
  642. if ($youtubeId = $this->id) {
  643. if (strpos($youtubeId, '//') !== false) {
  644. $parts = parse_url($this->id);
  645. if (array_key_exists('query', $parts)) {
  646. parse_str($parts['query'], $vars);
  648. if (isset($vars['v']) && $vars['v']) {
  649. $youtubeId = $vars['v'];
  650. }
  651. }
  653. //get youtube id if form urls like http://www.youtube.com/embed/youtubeId
  654. if (strpos($this->id, 'embed') !== false) {
  655. $explodedPath = explode('/', $parts['path']);
  656. $youtubeId = $explodedPath[array_search('embed', $explodedPath) + 1];
  657. }
  659. if (isset($parts['host']) && $parts['host'] === 'youtu.be') {
  660. $youtubeId = trim($parts['path'], ' /');
  661. }
  662. }
  663. }
  664. }
  666. return $youtubeId;
  667. }
  669. private function getYoutubeCode(bool $inAdmin = false): string
  670. {
  671. if (!$this->id) {
  672. return $this->getEmptyCode();
  673. }
  675. $config = $this->getConfig();
  676. $code = '';
  678. $youtubeId = $this->parseYoutubeId();
  679. if (!$youtubeId) {
  680. return $this->getEmptyCode();
  681. }
  683. if ($inAdmin && isset($config['editmodeImagePreview']) && $config['editmodeImagePreview'] === true) {
  684. return '<div id="pimcore_video_' . $this->getName() . '" class="pimcore_editable_video '. ($config['class'] ?? '') .'">
  685. <img src="https://img.youtube.com/vi/' . $youtubeId . '/0.jpg">
  686. </div>';
  687. }
  689. $width = '100%';
  690. if (array_key_exists('width', $config)) {
  691. $width = $config['width'];
  692. }
  694. $height = '300';
  695. if (array_key_exists('height', $config)) {
  696. $height = $config['height'];
  697. }
  699. $wmode = '?wmode=transparent';
  700. $seriesPrefix = '';
  701. if (strpos($youtubeId, 'PL') === 0) {
  702. $wmode = '';
  703. $seriesPrefix = 'videoseries?list=';
  704. }
  706. $valid_youtube_prams = [ 'autohide',
  707. 'autoplay',
  708. 'cc_load_policy',
  709. 'color',
  710. 'controls',
  711. 'disablekb',
  712. 'enablejsapi',
  713. 'end',
  714. 'fs',
  715. 'playsinline',
  716. 'hl',
  717. 'iv_load_policy',
  718. 'list',
  719. 'listType',
  720. 'loop',
  721. 'modestbranding',
  722. 'mute',
  723. 'origin',
  724. 'playerapiid',
  725. 'playlist',
  726. 'rel',
  727. 'showinfo',
  728. 'start',
  729. 'theme',
  730. ];
  731. $additional_params = '';
  733. $clipConfig = [];
  734. if (isset($config['config']['clip']) && is_array($config['config']['clip'])) {
  735. $clipConfig = $config['config']['clip'];
  736. }
  738. // this is to be backward compatible to <= v 1.4.7
  739. $configurations = $clipConfig;
  740. if (array_key_exists(self::TYPE_YOUTUBE, $config) && is_array($config[self::TYPE_YOUTUBE])) {
  741. $configurations = array_merge($clipConfig, $config[self::TYPE_YOUTUBE]);
  742. }
  744. if (!empty($configurations)) {
  745. foreach ($configurations as $key => $value) {
  746. if (in_array($key, $valid_youtube_prams)) {
  747. if (is_bool($value)) {
  748. if ($value) {
  749. $additional_params .= '&'.$key.'=1';
  750. } else {
  751. $additional_params .= '&'.$key.'=0';
  752. }
  753. } else {
  754. $additional_params .= '&'.$key.'='.$value;
  755. }
  756. }
  757. }
  758. }
  760. $code .= '<div id="pimcore_video_' . $this->getName() . '" class="pimcore_editable_video '. ($config['class'] ?? '') .'">
  761. <iframe width="' . $width . '" height="' . $height . '" src="https://www.youtube-nocookie.com/embed/' . $seriesPrefix . $youtubeId . $wmode . $additional_params .'" frameborder="0" webkitAllowFullScreen mozallowfullscreen allowfullscreen allow="fullscreen" data-type="pimcore_video_editable"></iframe>
  762. </div>';
  764. return $code;
  765. }
  767. private function getVimeoCode(bool $inAdmin = false): string
  768. {
  769. if (!$this->id) {
  770. return $this->getEmptyCode();
  771. }
  773. $config = $this->getConfig();
  774. $code = '';
  775. $uid = 'video_' . uniqid();
  777. // get vimeo id
  778. if (preg_match("@vimeo.*/([\d]+)@i", $this->id, $matches)) {
  779. $vimeoId = (int)$matches[1];
  780. } else {
  781. // for object-videos
  782. $vimeoId = $this->id;
  783. }
  785. if (ctype_digit($vimeoId)) {
  786. if ($inAdmin && isset($config['editmodeImagePreview']) && $config['editmodeImagePreview'] === true) {
  787. return '<div id="pimcore_video_' . $this->getName() . '" class="pimcore_editable_video '. ($config['class'] ?? '') .'">
  788. <img src="https://vumbnail.com/' . $vimeoId . '.jpg">
  789. </div>';
  790. }
  792. $width = '100%';
  793. if (array_key_exists('width', $config)) {
  794. $width = $config['width'];
  795. }
  797. $height = '300';
  798. if (array_key_exists('height', $config)) {
  799. $height = $config['height'];
  800. }
  802. $valid_vimeo_prams = [
  803. 'autoplay',
  804. 'background',
  805. 'loop',
  806. 'muted',
  807. ];
  809. $additional_params = '';
  811. $clipConfig = [];
  812. if (isset($config['config']['clip']) && is_array($config['config']['clip'])) {
  813. $clipConfig = $config['config']['clip'];
  814. }
  816. // this is to be backward compatible to <= v 1.4.7
  817. $configurations = $clipConfig;
  818. if (isset($config[self::TYPE_VIMEO]) && is_array($config[self::TYPE_VIMEO])) {
  819. $configurations = array_merge($clipConfig, $config[self::TYPE_VIMEO]);
  820. }
  822. if (!empty($configurations)) {
  823. foreach ($configurations as $key => $value) {
  824. if (in_array($key, $valid_vimeo_prams)) {
  825. if (is_bool($value)) {
  826. if ($value) {
  827. $additional_params .= '&'.$key.'=1';
  828. } else {
  829. $additional_params .= '&'.$key.'=0';
  830. }
  831. } else {
  832. $additional_params .= '&'.$key.'='.$value;
  833. }
  834. }
  835. }
  836. }
  838. $code .= '<div id="pimcore_video_' . $this->getName() . '" class="pimcore_editable_video '. ($config['class'] ?? '') .'">
  839. <iframe src="https://player.vimeo.com/video/' . $vimeoId . '?dnt=1&title=0&amp;byline=0&amp;portrait=0'. $additional_params .'" width="' . $width . '" height="' . $height . '" frameborder="0" webkitAllowFullScreen mozallowfullscreen allowfullscreen allow="fullscreen" data-type="pimcore_video_editable"></iframe>
  840. </div>';
  842. return $code;
  843. }
  845. // default => return the empty code
  846. return $this->getEmptyCode();
  847. }
  849. private function getDailymotionCode(bool $inAdmin = false): string
  850. {
  851. if (!$this->id) {
  852. return $this->getEmptyCode();
  853. }
  855. $config = $this->getConfig();
  856. $code = '';
  857. $uid = 'video_' . uniqid();
  859. // get dailymotion id
  860. if (preg_match('@dailymotion.*/video/([^_]+)@i', $this->id, $matches)) {
  861. $dailymotionId = $matches[1];
  862. } else {
  863. // for object-videos
  864. $dailymotionId = $this->id;
  865. }
  867. if ($dailymotionId) {
  868. if ($inAdmin && isset($config['editmodeImagePreview']) && $config['editmodeImagePreview'] === true) {
  869. return '<div id="pimcore_video_' . $this->getName() . '" class="pimcore_editable_video '. ($config['class'] ?? '') .'">
  870. <img src="https://www.dailymotion.com/thumbnail/video/' . $dailymotionId . '">
  871. </div>';
  872. }
  873. $width = $config['width'] ?? '100%';
  875. $height = $config['height'] ?? '300';
  877. $valid_dailymotion_prams = [
  878. 'autoplay',
  879. 'loop',
  880. 'mute', ];
  882. $additional_params = '';
  884. $clipConfig = isset($config['config']['clip']) && is_array($config['config']['clip']) ? $config['config']['clip'] : [];
  886. // this is to be backward compatible to <= v 1.4.7
  887. $configurations = $clipConfig;
  888. if (isset($config[self::TYPE_DAILYMOTION]) && is_array($config[self::TYPE_DAILYMOTION])) {
  889. $configurations = array_merge($clipConfig, $config[self::TYPE_DAILYMOTION]);
  890. }
  892. if (!empty($configurations)) {
  893. foreach ($configurations as $key => $value) {
  894. if (in_array($key, $valid_dailymotion_prams)) {
  895. if (is_bool($value)) {
  896. if ($value) {
  897. $additional_params .= '&'.$key.'=1';
  898. } else {
  899. $additional_params .= '&'.$key.'=0';
  900. }
  901. } else {
  902. $additional_params .= '&'.$key.'='.$value;
  903. }
  904. }
  905. }
  906. }
  908. $code .= '<div id="pimcore_video_' . $this->getName() . '" class="pimcore_editable_video '. ($config['class'] ?? '') .'">
  909. <iframe src="https://www.dailymotion.com/embed/video/' . $dailymotionId . '?' . $additional_params .'" width="' . $width . '" height="' . $height . '" frameborder="0" webkitAllowFullScreen mozallowfullscreen allowfullscreen allow="fullscreen" data-type="pimcore_video_editable"></iframe>
  910. </div>';
  912. return $code;
  913. }
  915. // default => return the empty code
  916. return $this->getEmptyCode();
  917. }
  919. /**
  920. * @param array $urls
  921. * @param Asset\Image\Thumbnail|Asset\Video\ImageThumbnail|null $thumbnail
  922. *
  923. * @return string
  924. */
  925. private function getHtml5Code($urls = [], $thumbnail = null)
  926. {
  927. $code = '';
  928. $video = $this->getVideoAsset();
  929. if ($video) {
  930. $code .= '<div id="pimcore_video_' . $this->getName() . '" class="pimcore_editable_video">' . "\n";
  932. $uploadDate = new \DateTime();
  933. $uploadDate->setTimestamp($video->getCreationDate());
  935. $jsonLd = [
  936. '@context' => 'https://schema.org',
  937. '@type' => 'VideoObject',
  938. 'name' => $this->getTitle(),
  939. 'description' => $this->getDescription(),
  940. 'uploadDate' => $uploadDate->format('Y-m-d\TH:i:sO'),
  941. //'contentUrl' => Tool::getHostUrl() . $urls['mp4'],
  942. //"embedUrl" => "http://www.example.com/videoplayer.swf?video=123",
  943. //"interactionCount" => "1234",
  944. ];
  945. $duration = $video->getDuration();
  947. if ($duration !== null) {
  948. $jsonLd['duration'] = $this->getDurationString($duration);
  949. }
  951. if (!$thumbnail) {
  952. $thumbnail = $video->getImageThumbnail([]);
  953. }
  955. $jsonLd['contentUrl'] = $urls['mp4'];
  956. if (!preg_match('@https?://@', $urls['mp4'])) {
  957. $jsonLd['contentUrl'] = Tool::getHostUrl() . $urls['mp4'];
  958. }
  960. $thumbnailUrl = (string)$thumbnail;
  961. $jsonLd['thumbnailUrl'] = $thumbnailUrl;
  962. if (!preg_match('@https?://@', $thumbnailUrl)) {
  963. $jsonLd['thumbnailUrl'] = Tool::getHostUrl() . $thumbnailUrl;
  964. }
  966. $code .= "\n\n<script type=\"application/ld+json\">\n" . json_encode($jsonLd) . "\n</script>\n\n";
  968. // default attributes
  969. $attributesString = '';
  970. $attributes = [
  971. 'width' => $this->getWidth(),
  972. 'height' => $this->getHeight(),
  973. 'poster' => $thumbnailUrl,
  974. 'controls' => 'controls',
  975. 'class' => 'pimcore_video',
  976. ];
  978. $config = $this->getConfig();
  980. if (array_key_exists('attributes', $config)) {
  981. $attributes = array_merge($attributes, $config['attributes']);
  982. }
  984. if (isset($config['removeAttributes']) && is_array($config['removeAttributes'])) {
  985. foreach ($config['removeAttributes'] as $attribute) {
  986. unset($attributes[$attribute]);
  987. }
  988. }
  990. // do not allow an empty controls editable
  991. if (isset($attributes['controls']) && !$attributes['controls']) {
  992. unset($attributes['controls']);
  993. }
  995. if (isset($urls['mpd'])) {
  996. $attributes['data-dashjs-player'] = null;
  997. }
  999. foreach ($attributes as $key => $value) {
  1000. $attributesString .= ' ' . $key;
  1001. if (!empty($value)) {
  1002. $quoteChar = '"';
  1003. if (is_string($value) && strpos($value, '"')) {
  1004. $quoteChar = "'";
  1005. }
  1006. $attributesString .= '=' . $quoteChar . $value . $quoteChar;
  1007. }
  1008. }
  1010. $code .= '<video' . $attributesString . '>' . "\n";
  1012. foreach ($urls as $type => $url) {
  1013. if ($type == 'medias') {
  1014. foreach ($url as $format => $medias) {
  1015. foreach ($medias as $media => $mediaUrl) {
  1016. $code .= '<source type="video/' . $format . '" src="' . $mediaUrl . '" media="' . $media . '" />' . "\n";
  1017. }
  1018. }
  1019. } else {
  1020. $code .= '<source type="video/' . $type . '" src="' . $url . '" />' . "\n";
  1021. }
  1022. }
  1024. $code .= '</video>' . "\n";
  1025. $code .= '</div>' . "\n";
  1026. }
  1028. return $code;
  1029. }
  1031. private function getDurationString(float $duration): string
  1032. {
  1033. $duration = ceil($duration);
  1034. $durationParts = ['PT'];
  1036. // hours
  1037. if ($duration / 3600 >= 1) {
  1038. $hours = floor($duration / 3600);
  1039. $durationParts[] = $hours . 'H';
  1040. $duration = $duration - $hours * 3600;
  1041. }
  1043. // minutes
  1044. if ($duration / 60 >= 1) {
  1045. $minutes = floor($duration / 60);
  1046. $durationParts[] = $minutes . 'M';
  1047. $duration = $duration - $minutes * 60;
  1048. }
  1050. $durationParts[] = $duration . 'S';
  1052. return implode('', $durationParts);
  1053. }
  1055. /**
  1056. * @param string|null $thumbnail
  1057. *
  1058. * @return string
  1059. */
  1060. private function getProgressCode($thumbnail = null)
  1061. {
  1062. $uid = 'video_' . uniqid();
  1063. $code = '
  1064. <div id="pimcore_video_' . $this->getName() . '" class="pimcore_editable_video">
  1065. <style type="text/css">
  1066. #' . $uid . ' .pimcore_editable_video_progress_status {
  1067. box-sizing:content-box;
  1068. background:#fff url(/bundles/pimcoreadmin/img/video-loading.gif) center center no-repeat;
  1069. width:66px;
  1070. height:66px;
  1071. padding:20px;
  1072. border:1px solid #555;
  1073. box-shadow: 2px 2px 5px #333;
  1074. border-radius:20px;
  1075. margin: 0 20px 0 20px;
  1076. top: calc(50% - 66px);
  1077. left: calc(50% - 66px);
  1078. position:absolute;
  1079. opacity: 0.8;
  1080. }
  1081. </style>
  1082. <div class="pimcore_editable_video_progress" id="' . $uid . '">
  1083. <img src="' . $thumbnail . '" style="width: ' . $this->getWidthWithUnit() . '; height: ' . $this->getHeightWithUnit() . ';">
  1084. <div class="pimcore_editable_video_progress_status"></div>
  1085. </div>
  1086. </div>';
  1088. return $code;
  1089. }
  1091. /**
  1092. * @return string
  1093. */
  1094. private function getEmptyCode(): string
  1095. {
  1096. $uid = 'video_' . uniqid();
  1098. return '<div id="pimcore_video_' . $this->getName() . '" class="pimcore_editable_video"><div class="pimcore_editable_video_empty" id="' . $uid . '" style="width: ' . $this->getWidthWithUnit() . '; height: ' . $this->getHeightWithUnit() . ';"></div></div>';
  1099. }
  1101. private function updateAllowedTypesFromConfig(array $config): void
  1102. {
  1103. $this->allowedTypes = self::ALLOWED_TYPES;
  1105. if (
  1106. isset($config['allowedTypes']) === true
  1107. && empty($config['allowedTypes']) === false
  1108. && empty(array_diff($config['allowedTypes'], self::ALLOWED_TYPES))
  1109. ) {
  1110. $this->allowedTypes = $config['allowedTypes'];
  1111. }
  1112. }
  1114. /**
  1115. * {@inheritdoc}
  1116. */
  1117. public function isEmpty()
  1118. {
  1119. if ($this->id) {
  1120. return false;
  1121. }
  1123. return true;
  1124. }
  1126. /**
  1127. * @return string
  1128. */
  1129. public function getVideoType()
  1130. {
  1131. if (empty($this->type) === true) {
  1132. $this->type = $this->getAllowedTypes()[0];
  1133. }
  1135. return $this->type;
  1136. }
  1138. /**
  1139. * @return Asset\Video|null
  1140. */
  1141. public function getVideoAsset()
  1142. {
  1143. if ($this->getVideoType() === self::TYPE_ASSET) {
  1144. return Asset\Video::getById($this->id);
  1145. }
  1147. return null;
  1148. }
  1150. /**
  1151. * @return Asset\Image|null
  1152. */
  1153. public function getPosterAsset()
  1154. {
  1155. return Asset\Image::getById($this->poster);
  1156. }
  1158. /**
  1159. * @param string|Asset\Video\Thumbnail\Config $config
  1160. *
  1161. * @return Asset\Image\Thumbnail|Asset\Video\ImageThumbnail|string
  1162. *
  1163. * TODO Pimcore 11: Change empty string return to null
  1164. */
  1165. public function getImageThumbnail($config)
  1166. {
  1167. if ($this->poster && ($poster = Asset\Image::getById($this->poster))) {
  1168. return $poster->getThumbnail($config);
  1169. }
  1171. if ($this->getVideoAsset()) {
  1172. return $this->getVideoAsset()->getImageThumbnail($config);
  1173. }
  1175. return '';
  1176. }
  1178. /**
  1179. * @param string|Asset\Video\Thumbnail\Config $config
  1180. *
  1181. * @return array
  1182. */
  1183. public function getThumbnail($config)
  1184. {
  1185. if ($this->getVideoAsset()) {
  1186. return $this->getVideoAsset()->getThumbnail($config);
  1187. }
  1189. return [];
  1190. }
  1192. /**
  1193. * {@inheritdoc}
  1194. */
  1195. public function rewriteIds($idMapping) /** : void */
  1196. {
  1197. if ($this->type == self::TYPE_ASSET && array_key_exists(self::TYPE_ASSET, $idMapping) && array_key_exists($this->getId(), $idMapping[self::TYPE_ASSET])) {
  1198. $this->setId($idMapping[self::TYPE_ASSET][$this->getId()]);
  1199. }
  1200. }
  1201. }