Initial commit - Typo3 11.5.41
This commit is contained in:
Matteo Gallo
@@ -0,0 +1,458 @@
|
||||
<?php
|
||||
|
||||
namespace MiniFranske\FsMediaGallery\Controller;
|
||||
|
||||
/***************************************************************
|
||||
* Copyright notice
|
||||
*
|
||||
* (c) 2014 Frans Saris <franssaris@gmail.com>
|
||||
*
|
||||
* All rights reserved
|
||||
*
|
||||
* This script is part of the TYPO3 project. The TYPO3 project is
|
||||
* free software; you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation; either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* The GNU General Public License can be found at
|
||||
* http://www.gnu.org/copyleft/gpl.html.
|
||||
*
|
||||
* This script is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU General Public License for more details.
|
||||
*
|
||||
* This copyright notice MUST APPEAR in all copies of the script!
|
||||
***************************************************************/
|
||||
|
||||
use GeorgRinger\NumberedPagination\NumberedPagination;
|
||||
use MiniFranske\FsMediaGallery\Pagination\ExtendedArrayPaginator;
|
||||
use MiniFranske\FsMediaGallery\Utility\TypoScriptUtility;
|
||||
use MiniFranske\FsMediaGallery\Domain\Repository\MediaAlbumRepository;
|
||||
use Psr\Http\Message\ResponseInterface;
|
||||
use TYPO3\CMS\Core\Pagination\ArrayPaginator;
|
||||
use TYPO3\CMS\Core\Pagination\SimplePagination;
|
||||
use TYPO3\CMS\Extbase\Http\ForwardResponse;
|
||||
use TYPO3\CMS\Frontend\Controller\ErrorController;
|
||||
use TYPO3\CMS\Core\Http\ImmediateResponseException;
|
||||
use MiniFranske\FsMediaGallery\Domain\Model\MediaAlbum;
|
||||
use TYPO3\CMS\Core\Utility\GeneralUtility;
|
||||
use TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface;
|
||||
use TYPO3\CMS\Extbase\Mvc\Controller\ActionController;
|
||||
use TYPO3\CMS\Extbase\Utility\LocalizationUtility;
|
||||
|
||||
/**
|
||||
* MediaAlbumController
|
||||
*/
|
||||
class MediaAlbumController extends ActionController
|
||||
{
|
||||
|
||||
/**
|
||||
* mediaAlbumRepository
|
||||
*
|
||||
* @var \MiniFranske\FsMediaGallery\Domain\Repository\MediaAlbumRepository
|
||||
*/
|
||||
protected $mediaAlbumRepository;
|
||||
|
||||
/**
|
||||
* Injects the Configuration Manager
|
||||
*
|
||||
* @param ConfigurationManagerInterface $configurationManager Instance of the Configuration Manager
|
||||
* @return void
|
||||
*/
|
||||
public function injectConfigurationManager(ConfigurationManagerInterface $configurationManager)
|
||||
{
|
||||
$this->configurationManager = $configurationManager;
|
||||
|
||||
$frameworkSettings = $this->configurationManager->getConfiguration(
|
||||
ConfigurationManagerInterface::CONFIGURATION_TYPE_FRAMEWORK,
|
||||
'fsmediagallery',
|
||||
'fsmediagallery_mediagallery'
|
||||
);
|
||||
$flexformSettings = $this->configurationManager->getConfiguration(
|
||||
ConfigurationManagerInterface::CONFIGURATION_TYPE_SETTINGS
|
||||
);
|
||||
|
||||
// merge Framework (TypoScript) and Flexform settings
|
||||
if (isset($frameworkSettings['settings']['overrideFlexformSettingsIfEmpty'])) {
|
||||
/** @var $typoScriptUtility \MiniFranske\FsMediaGallery\Utility\TypoScriptUtility */
|
||||
$typoScriptUtility = GeneralUtility::makeInstance(TypoScriptUtility::class);
|
||||
$mergedSettings = $typoScriptUtility->override($flexformSettings, $frameworkSettings);
|
||||
$this->settings = $mergedSettings;
|
||||
} else {
|
||||
$this->settings = $flexformSettings;
|
||||
}
|
||||
|
||||
/**
|
||||
* sync persistence.storagePid=settings.startingpoint and persistence.recursive=settings.recursive
|
||||
*/
|
||||
// overwrite persistence.storagePid if settings.startingpoint is defined in flexform
|
||||
if (!empty($this->settings['startingpoint'])) {
|
||||
$frameworkSettings['persistence']['storagePid'] = $this->settings['startingpoint'];
|
||||
// if settings.startingpoint is not set in flexform, use persistence.storagePid from TS
|
||||
} elseif (!empty($frameworkSettings['persistence']['storagePid'])) {
|
||||
$this->settings['startingpoint'] = $frameworkSettings['persistence']['storagePid'];
|
||||
// startingpoint/storagePid is not set via TS nor flexforms > fallback to current pid
|
||||
} else {
|
||||
$this->settings['startingpoint'] = $frameworkSettings['persistence']['storagePid'] = $GLOBALS['TSFE']->id;
|
||||
}
|
||||
|
||||
// set persistence.recursive if settings.recursive is defined in flexform
|
||||
if (!empty($this->settings['recursive'])) {
|
||||
$frameworkSettings['persistence']['recursive'] = $this->settings['recursive'];
|
||||
// if settings.recursive is not set in flexform, use persistence.recursive from TS
|
||||
} elseif (!empty($frameworkSettings['persistence']['recursive'])) {
|
||||
$this->settings['recursive'] = $frameworkSettings['persistence']['recursive'];
|
||||
// recursive is not set via TS nor flexforms
|
||||
} else {
|
||||
$this->settings['recursive'] = $frameworkSettings['persistence']['recursive'] = 0;
|
||||
}
|
||||
|
||||
// write back altered configuration
|
||||
$this->configurationManager->setConfiguration($frameworkSettings);
|
||||
|
||||
// check some settings
|
||||
if (!isset($this->settings['list']['pagination']['itemsPerPage']) || $this->settings['list']['pagination']['itemsPerPage'] < 1) {
|
||||
$this->settings['list']['pagination']['itemsPerPage'] = 12;
|
||||
}
|
||||
if (!isset($this->settings['album']['pagination']['itemsPerPage']) || $this->settings['album']['pagination']['itemsPerPage'] < 1) {
|
||||
$this->settings['album']['pagination']['itemsPerPage'] = 12;
|
||||
}
|
||||
// correct resizeMode 's' set in flexforms (flexforms value '' is used for inherit/definition by TS)
|
||||
if (isset($this->settings['list']['thumb']['resizeMode']) && $this->settings['list']['thumb']['resizeMode'] == 's') {
|
||||
$this->settings['list']['thumb']['resizeMode'] = '';
|
||||
}
|
||||
if (isset($this->settings['album']['thumb']['resizeMode']) && $this->settings['album']['thumb']['resizeMode'] == 's') {
|
||||
$this->settings['album']['thumb']['resizeMode'] = '';
|
||||
}
|
||||
if (isset($this->settings['detail']['asset']['resizeMode']) && $this->settings['detail']['asset']['resizeMode'] == 's') {
|
||||
$this->settings['detail']['asset']['resizeMode'] = '';
|
||||
}
|
||||
if (isset($this->settings['random']['thumb']['resizeMode']) && $this->settings['random']['thumb']['resizeMode'] == 's') {
|
||||
$this->settings['random']['thumb']['resizeMode'] = '';
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Injects the MediaAlbumRepository
|
||||
*
|
||||
* @param \MiniFranske\FsMediaGallery\Domain\Repository\MediaAlbumRepository $mediaAlbumRepository
|
||||
* @return void
|
||||
*/
|
||||
public function injectMediaAlbumRepository(
|
||||
MediaAlbumRepository $mediaAlbumRepository
|
||||
)
|
||||
{
|
||||
$this->mediaAlbumRepository = $mediaAlbumRepository;
|
||||
if (!empty($this->settings['allowedAssetMimeTypes'])) {
|
||||
$this->mediaAlbumRepository->setAllowedAssetMimeTypes(GeneralUtility::trimExplode(',',
|
||||
$this->settings['allowedAssetMimeTypes']));
|
||||
}
|
||||
if (isset($this->settings['album']['assets']['orderBy'])) {
|
||||
$this->mediaAlbumRepository->setAssetsOrderBy($this->settings['album']['assets']['orderBy']);
|
||||
}
|
||||
if (isset($this->settings['album']['assets']['orderDirection'])) {
|
||||
$this->mediaAlbumRepository->setAssetsOrderDirection($this->settings['album']['assets']['orderDirection']);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Set album uid restrictions as defined in settings
|
||||
* By setting this in the repository also the MediaAlbum::getAlbums()
|
||||
* and MediaAlbum::getRandomAlbum() is restricted to these uids.
|
||||
*/
|
||||
protected function setAlbumUidRestrictions()
|
||||
{
|
||||
$mediaAlbumsUids = GeneralUtility::trimExplode(',', $this->settings['mediaAlbumsUids'], true);
|
||||
$this->mediaAlbumRepository->setAlbumUids($mediaAlbumsUids);
|
||||
$this->mediaAlbumRepository->setUseAlbumUidsAsExclude(!empty($this->settings['useAlbumFilterAsExclude']));
|
||||
}
|
||||
|
||||
/**
|
||||
* Index Action
|
||||
* As switchableControllerActions can be limited in EM this function
|
||||
* is needed as default action (with no output).
|
||||
* It is set as default action in flexform to make sure the
|
||||
* correct tabs/fields are shown when a new plugin is added.
|
||||
*/
|
||||
public function indexAction(): ResponseInterface
|
||||
{
|
||||
return $this->htmlResponse('<i>Please select a display mode in the plugin.</i>');
|
||||
}
|
||||
|
||||
/**
|
||||
* NestedList Action
|
||||
* Displays a (nested) list of albums; default/show action in fs_media_gallery <= 1.0.0
|
||||
*
|
||||
* @param int $mediaAlbum (this is not directly mapped to an object to handle 404 on our own)
|
||||
*/
|
||||
public function nestedListAction(int $mediaAlbum = 0): ResponseInterface
|
||||
{
|
||||
$mediaAlbums = null;
|
||||
$mediaAlbum = (int)$mediaAlbum ?: null;
|
||||
$showBackLink = true;
|
||||
|
||||
$this->setAlbumUidRestrictions();
|
||||
|
||||
// Single view
|
||||
if ($mediaAlbum) {
|
||||
/** @var MediaAlbum $mediaAlbum */
|
||||
$mediaAlbum = $this->mediaAlbumRepository->findByUid($mediaAlbum);
|
||||
if (!$mediaAlbum) {
|
||||
return $this->pageNotFound(LocalizationUtility::translate('no_album_found', 'fs_media_gallery'));
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* No album selected and album restriction set, find all "root" albums
|
||||
* Albums without parent or with parent not selected as allowed
|
||||
*/
|
||||
if ($mediaAlbum === null && $this->mediaAlbumRepository->getAlbumUids() !== []) {
|
||||
$mediaAlbums = [];
|
||||
$all = $this->mediaAlbumRepository->findAll((bool)$this->settings['list']['hideEmptyAlbums'], $this->settings['list']['orderBy'], $this->settings['list']['orderDirection']);
|
||||
/** @var MediaAlbum $album */
|
||||
foreach ($all as $album) {
|
||||
$parent = $album->getParentalbum();
|
||||
if ($parent === null
|
||||
|| (!$this->mediaAlbumRepository->getUseAlbumUidsAsExclude() && !in_array($parent->getUid(),
|
||||
$this->mediaAlbumRepository->getAlbumUids()))
|
||||
|| ($this->mediaAlbumRepository->getUseAlbumUidsAsExclude() && in_array($parent->getUid(),
|
||||
$this->mediaAlbumRepository->getAlbumUids()))
|
||||
) {
|
||||
$mediaAlbums[] = $album;
|
||||
}
|
||||
}
|
||||
} else {
|
||||
$mediaAlbums = $this->mediaAlbumRepository->findByParentalbum($mediaAlbum,
|
||||
$this->settings['list']['hideEmptyAlbums'], $this->settings['list']['orderBy'],
|
||||
$this->settings['list']['orderDirection']);
|
||||
}
|
||||
|
||||
// when only 1 album skip gallery view
|
||||
if ($mediaAlbum === null && !empty($this->settings['list']['skipListWhenOnlyOneAlbum']) && count($mediaAlbums) === 1) {
|
||||
$mediaAlbum = $mediaAlbums[0];
|
||||
$mediaAlbums = $this->mediaAlbumRepository->findByParentalbum($mediaAlbum,
|
||||
$this->settings['list']['hideEmptyAlbums'], $this->settings['list']['orderBy'],
|
||||
$this->settings['list']['orderDirection']);
|
||||
$showBackLink = false;
|
||||
}
|
||||
|
||||
if ($mediaAlbum && $mediaAlbum->getParentalbum() && (
|
||||
$this->mediaAlbumRepository->getAlbumUids() === []
|
||||
||
|
||||
(!$this->mediaAlbumRepository->getUseAlbumUidsAsExclude() && in_array($mediaAlbum->getParentalbum()->getUid(),
|
||||
$this->mediaAlbumRepository->getAlbumUids()))
|
||||
||
|
||||
($this->mediaAlbumRepository->getUseAlbumUidsAsExclude() && !in_array($mediaAlbum->getParentalbum()->getUid(),
|
||||
$this->mediaAlbumRepository->getAlbumUids()))
|
||||
)
|
||||
) {
|
||||
$this->view->assign('parentAlbum', $mediaAlbum->getParentalbum());
|
||||
}
|
||||
|
||||
$this->view->assign('showBackLink', $showBackLink);
|
||||
$this->view->assign('mediaAlbums', $mediaAlbums);
|
||||
$this->view->assign('mediaAlbum', $mediaAlbum);
|
||||
|
||||
if ($mediaAlbums) {
|
||||
$this->view->assign('mediaAlbumsPagination', $this->getAlbumsPagination($mediaAlbums));
|
||||
}
|
||||
if ($mediaAlbum) {
|
||||
$this->view->assign('mediaAlbumPagination', $this->getAlbumPagination($mediaAlbum));
|
||||
}
|
||||
|
||||
return $this->htmlResponse();
|
||||
}
|
||||
|
||||
/**
|
||||
* FlatList Action
|
||||
* Displays a (one-dimensional, flattened) list of albums
|
||||
*
|
||||
* @param int $mediaAlbum (this is not directly mapped to an object to handle 404 on our own)
|
||||
*/
|
||||
public function flatListAction(int $mediaAlbum = 0): ResponseInterface
|
||||
{
|
||||
$showBackLink = true;
|
||||
if ($mediaAlbum) {
|
||||
// if an album is given, display it
|
||||
$mediaAlbum = $this->mediaAlbumRepository->findByUid($mediaAlbum);
|
||||
if (!$mediaAlbum) {
|
||||
return $this->pageNotFound(LocalizationUtility::translate('no_album_found', 'fs_media_gallery'));
|
||||
}
|
||||
$this->view->assign('displayMode', 'album');
|
||||
$this->view->assign('mediaAlbum', $mediaAlbum);
|
||||
} else {
|
||||
// display the album list
|
||||
$mediaAlbums = $this->mediaAlbumRepository->findAll($this->settings['list']['hideEmptyAlbums'],
|
||||
$this->settings['list']['orderBy'], $this->settings['list']['orderDirection']);
|
||||
$this->view->assign('displayMode', 'flatList');
|
||||
$this->view->assign('mediaAlbums', $mediaAlbums);
|
||||
$showBackLink = false;
|
||||
}
|
||||
$this->view->assign('showBackLink', $showBackLink);
|
||||
|
||||
if ($mediaAlbum) {
|
||||
$this->view->assign('mediaAlbumPagination', $this->getAlbumPagination($mediaAlbum));
|
||||
}
|
||||
|
||||
return $this->htmlResponse();
|
||||
}
|
||||
|
||||
/**
|
||||
* Show single Album (defined in FlexForm/TS) Action
|
||||
* As showAlbumAction() displays any album by the given param this function gets its value from TS/Felxform
|
||||
* This could be merged with showAlbumAction() if there is a way to determine which switchableControllerActions is defined in Felxform.
|
||||
*/
|
||||
public function showAlbumByConfigAction(): ResponseInterface
|
||||
{
|
||||
// get all request arguments (e.g. pagination widget)
|
||||
$arguments = $this->request->getArguments();
|
||||
// set album id from settings
|
||||
$arguments['mediaAlbum'] = $this->settings['mediaAlbum'];
|
||||
|
||||
return (new ForwardResponse('showAlbum'))->withArguments($arguments);
|
||||
}
|
||||
|
||||
/**
|
||||
* Show single Album Action
|
||||
*
|
||||
* @param int $mediaAlbum (this is not directly mapped to an object to handle 404 on our own)
|
||||
*/
|
||||
public function showAlbumAction(int $mediaAlbum = null): ResponseInterface
|
||||
{
|
||||
$mediaAlbum = (int)$mediaAlbum ?: null;
|
||||
if (empty($mediaAlbum)) {
|
||||
$mediaAlbum = (int)$this->settings['mediaAlbum'];
|
||||
}
|
||||
// if album uid is set through settings (typoscript or flexform) we skip the storage check
|
||||
$respectStorage = true;
|
||||
if ((int)$this->settings['mediaAlbum'] === (int)$mediaAlbum) {
|
||||
$respectStorage = false;
|
||||
}
|
||||
$mediaAlbum = $this->mediaAlbumRepository->findByUid($mediaAlbum, $respectStorage);
|
||||
$this->view->assign('mediaAlbum', $mediaAlbum);
|
||||
$this->view->assign('showBackLink', false);
|
||||
$this->view->assign('mediaAlbumPagination', $this->getAlbumPagination($mediaAlbum));
|
||||
|
||||
return $this->htmlResponse();
|
||||
}
|
||||
|
||||
/**
|
||||
* Show single media asset from album
|
||||
*
|
||||
* @param \MiniFranske\FsMediaGallery\Domain\Model\MediaAlbum $mediaAlbum
|
||||
* @param int $mediaAssetUid
|
||||
* @TYPO3\CMS\Extbase\Annotation\IgnoreValidation("")
|
||||
*/
|
||||
public function showAssetAction(MediaAlbum $mediaAlbum, int $mediaAssetUid): ResponseInterface
|
||||
{
|
||||
|
||||
if (isset($this->settings['album']['assets']['orderBy'])) {
|
||||
$mediaAlbum->setAssetsOrderBy($this->settings['album']['assets']['orderBy']);
|
||||
}
|
||||
|
||||
if (isset($this->settings['album']['assets']['orderDirection'])) {
|
||||
$mediaAlbum->setAssetsOrderDirection($this->settings['album']['assets']['orderDirection']);
|
||||
}
|
||||
|
||||
list($previousAsset, $mediaAsset, $nextAsset) = $mediaAlbum->getPreviousCurrentAndNext($mediaAssetUid);
|
||||
if (!$mediaAsset) {
|
||||
$message = LocalizationUtility::translate('asset_not_found', 'fs_media_gallery');
|
||||
return $this->pageNotFound((empty($message) ? 'Asset not found.' : $message));
|
||||
}
|
||||
$this->view->assign('previousAsset', $previousAsset);
|
||||
$this->view->assign('nextAsset', $nextAsset);
|
||||
$this->view->assign('mediaAsset', $mediaAsset);
|
||||
$this->view->assign('mediaAlbum', $mediaAlbum);
|
||||
|
||||
return $this->htmlResponse();
|
||||
}
|
||||
|
||||
/**
|
||||
* Show random media asset
|
||||
*/
|
||||
public function randomAssetAction(): ResponseInterface
|
||||
{
|
||||
|
||||
$this->setAlbumUidRestrictions();
|
||||
|
||||
$mediaAlbum = $this->mediaAlbumRepository->findRandom();
|
||||
$this->view->assign('mediaAlbum', $mediaAlbum);
|
||||
|
||||
return $this->htmlResponse();
|
||||
}
|
||||
|
||||
/**
|
||||
* If there were validation errors, we don't want to write details like
|
||||
* "An error occurred while trying to call Tx_Community_Controller_UserController->updateAction()"
|
||||
*
|
||||
* @return string|boolean The flash message or FALSE if no flash message should be set
|
||||
*/
|
||||
protected function getErrorFlashMessage(): bool
|
||||
{
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Page not found wrapper
|
||||
*
|
||||
* @throws ImmediateResponseException
|
||||
*/
|
||||
protected function pageNotFound(string $message): ResponseInterface
|
||||
{
|
||||
if (!empty($GLOBALS['TSFE'])) {
|
||||
$response = GeneralUtility::makeInstance(ErrorController::class)->pageNotFoundAction($GLOBALS['TYPO3_REQUEST'], $message);
|
||||
throw new ImmediateResponseException($response);
|
||||
}
|
||||
|
||||
return $this->htmlResponse($message);
|
||||
}
|
||||
|
||||
private function getAlbumPagination(MediaAlbum $album): array
|
||||
{
|
||||
$paginationConfiguration = $this->settings['album']['pagination'] ?? [];
|
||||
|
||||
$itemsPerPage = (int)($paginationConfiguration['itemsPerPage'] ?? 10);
|
||||
$maximumNumberOfLinks = (int)($paginationConfiguration['maximumNumberOfLinks'] ?? 0);
|
||||
|
||||
$currentPage = $this->request->hasArgument('currentPage') ? (int)$this->request->getArgument('currentPage') : 1;
|
||||
$paginator = GeneralUtility::makeInstance(ExtendedArrayPaginator::class, $album->getAssets(), $currentPage, $itemsPerPage);
|
||||
$paginationClass = $paginationConfiguration['class'] ?? SimplePagination::class;
|
||||
if ($paginationClass === NumberedPagination::class && $maximumNumberOfLinks) {
|
||||
$pagination = GeneralUtility::makeInstance(NumberedPagination::class, $paginator, $maximumNumberOfLinks);
|
||||
} else {
|
||||
$pagination = GeneralUtility::makeInstance(SimplePagination::class, $paginator);
|
||||
}
|
||||
|
||||
return [
|
||||
'currentPage' => $currentPage,
|
||||
'paginator' => $paginator,
|
||||
'pagination' => $pagination,
|
||||
];
|
||||
}
|
||||
|
||||
private function getAlbumsPagination(array $albums): array
|
||||
{
|
||||
$paginationConfiguration = $this->settings['list']['pagination'] ?? [];
|
||||
|
||||
$itemsPerPage = (int)($paginationConfiguration['itemsPerPage'] ?? 10);
|
||||
$maximumNumberOfLinks = (int)($paginationConfiguration['maximumNumberOfLinks'] ?? 0);
|
||||
|
||||
$currentPage = $this->request->hasArgument('currentAlbumPage') ? (int)$this->request->getArgument('currentAlbumPage') : 1;
|
||||
$paginator = GeneralUtility::makeInstance(ArrayPaginator::class, $albums, $currentPage, $itemsPerPage);
|
||||
$paginationClass = $paginationConfiguration['class'] ?? SimplePagination::class;
|
||||
if ($paginationClass === NumberedPagination::class && $maximumNumberOfLinks) {
|
||||
$pagination = GeneralUtility::makeInstance(NumberedPagination::class, $paginator, $maximumNumberOfLinks);
|
||||
} else {
|
||||
$pagination = GeneralUtility::makeInstance(SimplePagination::class, $paginator);
|
||||
}
|
||||
|
||||
return [
|
||||
'currentPage' => $currentPage,
|
||||
'paginator' => $paginator,
|
||||
'pagination' => $pagination,
|
||||
];
|
||||
}
|
||||
|
||||
}
|
||||
Reference in New Issue
Block a user