forked from contao/contao
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added ContentCompositionListener to correctly show or hide article fe…
…atures
- Loading branch information
Showing
4 changed files
with
303 additions
and
63 deletions.
There are no files selected for viewing
268 changes: 268 additions & 0 deletions
268
core-bundle/src/EventListener/DataContainer/ContentCompositionListener.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,268 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| /* | ||
| * This file is part of Contao. | ||
| * | ||
| * (c) Leo Feyer | ||
| * | ||
| * @license LGPL-3.0-or-later | ||
| */ | ||
|
|
||
| namespace Contao\CoreBundle\EventListener\DataContainer; | ||
|
|
||
| use Contao\Backend; | ||
| use Contao\BackendUser; | ||
| use Contao\CoreBundle\Framework\Adapter; | ||
| use Contao\CoreBundle\Framework\ContaoFramework; | ||
| use Contao\CoreBundle\Routing\Content\PageProviderInterface; | ||
| use Contao\CoreBundle\ServiceAnnotation\Callback; | ||
| use Contao\DataContainer; | ||
| use Contao\Image; | ||
| use Contao\LayoutModel; | ||
| use Contao\PageModel; | ||
| use Contao\StringUtil; | ||
| use Doctrine\DBAL\Connection; | ||
| use Symfony\Component\DependencyInjection\ServiceLocator; | ||
| use Symfony\Component\HttpFoundation\RequestStack; | ||
| use Symfony\Component\Security\Core\Security; | ||
| use Symfony\Contracts\Translation\TranslatorInterface; | ||
| use Terminal42\ServiceAnnotationBundle\ServiceAnnotationInterface; | ||
|
|
||
| class ContentCompositionListener implements ServiceAnnotationInterface | ||
| { | ||
| /** | ||
| * @var ContaoFramework | ||
| */ | ||
| private $framework; | ||
|
|
||
| /** | ||
| * @var Security | ||
| */ | ||
| private $security; | ||
|
|
||
| /** | ||
| * @var ServiceLocator | ||
| */ | ||
| private $pageProviders; | ||
|
|
||
| /** | ||
| * @var TranslatorInterface | ||
| */ | ||
| private $translator; | ||
|
|
||
| /** | ||
| * @var Connection | ||
| */ | ||
| private $connection; | ||
|
|
||
| /** | ||
| * @var RequestStack | ||
| */ | ||
| private $requestStack; | ||
|
|
||
| /** | ||
| * @var Adapter&Image | ||
| */ | ||
| private $image; | ||
|
|
||
| /** | ||
| * @var Adapter&Backend | ||
| */ | ||
| private $backend; | ||
|
|
||
| public function __construct(ContaoFramework $framework, Security $security, ServiceLocator $pageProviders, TranslatorInterface $translator, Connection $connection, RequestStack $requestStack) | ||
| { | ||
| $this->framework = $framework; | ||
| $this->security = $security; | ||
| $this->pageProviders = $pageProviders; | ||
| $this->translator = $translator; | ||
| $this->connection = $connection; | ||
| $this->requestStack = $requestStack; | ||
|
|
||
| $this->image = $this->framework->getAdapter(Image::class); | ||
| $this->backend = $this->framework->getAdapter(Backend::class); | ||
| } | ||
|
|
||
| /** | ||
| * @Callback(table="tl_page", target="list.operations.articles.button") | ||
| */ | ||
| public function renderPageArticlesOperation(array $row, string $href, string $label, string $title, string $icon) | ||
| { | ||
| if (!$this->security->isGranted('contao_user.modules', 'article')) { | ||
| return ''; | ||
| } | ||
|
|
||
| $pageModel = new PageModel(); | ||
| $pageModel->preventSaving(false); | ||
| $pageModel->setRow($row); | ||
|
|
||
| if (!$this->supportsComposition($pageModel) || !$this->hasArticlesInLayout($pageModel)) { | ||
| return $this->image->getHtml(preg_replace('/\.svg$/i', '_.svg', $icon)) . ' '; | ||
| } | ||
|
|
||
| return sprintf( | ||
| '<a href="%s" title="%s">%s</a> ', | ||
| $this->backend->addToUrl($href . '&pn=' . $row['id']), | ||
| StringUtil::specialchars($title), | ||
| $this->image->getHtml($icon, $label) | ||
| ); | ||
| } | ||
|
|
||
| /** | ||
| * Automatically create an article in the main column of a new page | ||
| * | ||
| * @Callback(table="tl_page", target="config.onsubmit") | ||
| */ | ||
| public function generateArticleForPage(DataContainer $dc) | ||
| { | ||
| $request = $this->requestStack->getCurrentRequest(); | ||
|
|
||
| // Return if there is no active record (override all) | ||
| if (!$dc->activeRecord || null === $request || !$request->hasSession()) { | ||
| return; | ||
| } | ||
|
|
||
| $pageModel = new PageModel(); | ||
| $pageModel->preventSaving(false); | ||
| $pageModel->setRow((array) $dc->activeRecord); | ||
|
|
||
| if ( | ||
| empty($pageModel->title) | ||
| || !$this->supportsComposition($pageModel) | ||
| || !$this->hasArticlesInLayout($pageModel) | ||
| ) { | ||
| return; | ||
| } | ||
|
|
||
| $sessionBag = $request->getSession()->getBag('contao_backend'); | ||
| $new_records = $sessionBag->get('new_records'); | ||
|
|
||
| // Not a new page | ||
| if (!$new_records || !is_array($new_records[$dc->table]) || !in_array($dc->id, $new_records[$dc->table])) { | ||
| return; | ||
| } | ||
|
|
||
| // Check whether there are articles (e.g. on copied pages) | ||
| $total = $this->connection->executeQuery( | ||
| "SELECT COUNT(*) AS count FROM tl_article WHERE pid=:pid", | ||
| ['pid' => $dc->id] | ||
| )->fetchColumn(); | ||
|
|
||
| if ($total > 0) { | ||
| return; | ||
| } | ||
|
|
||
| // Create article | ||
| $article = [ | ||
| 'pid' => $dc->id, | ||
| 'sorting' => 128, | ||
| 'tstamp' => time(), | ||
| 'author' => $this->security->getUser()->id, | ||
| 'inColumn' => 'main', | ||
| 'title' => $dc->activeRecord->title, | ||
| 'alias' => str_replace('/', '-', $dc->activeRecord->alias), // see #516 | ||
| 'published' => $dc->activeRecord->published, | ||
| ]; | ||
|
|
||
| $this->connection->insert('tl_article', $article); | ||
| } | ||
|
|
||
| /** | ||
| * @Callback(table="tl_article", target="list.sorting.paste_button") | ||
| */ | ||
| public function renderArticlePasteButton(DataContainer $dc, array $row, string $table, bool $cr, array $clipboard = null) | ||
| { | ||
| $user = $this->security->getUser(); | ||
| if (!$user instanceof BackendUser) { | ||
| return ''; | ||
| } | ||
|
|
||
| if ($table === $GLOBALS['TL_DCA'][$dc->table]['config']['ptable']) { | ||
| $pageModel = new PageModel(); | ||
| $pageModel->preventSaving(false); | ||
| $pageModel->setRow($row); | ||
|
|
||
| // Do not show paste button for pages without content composition or articles in layout | ||
| if (!$this->supportsComposition($pageModel) || !$this->hasArticlesInLayout($pageModel)) { | ||
| return ''; | ||
| } | ||
|
|
||
| if ($cr || !$user->isAllowed(BackendUser::CAN_EDIT_ARTICLE_HIERARCHY, $row)) { | ||
| return $this->image->getHtml('pasteinto_.svg'); | ||
| } | ||
|
|
||
| return sprintf( | ||
| '<a href="%s" title="%s" onclick="Backend.getScrollOffset()">%s</a> ', | ||
| $this->backend->addToUrl('act=' . $clipboard['mode'] . '&mode=2&pid=' . $row['id'] . (!is_array($clipboard['id']) ? '&id=' . $clipboard['id'] : '')), | ||
| StringUtil::specialchars($this->translator->trans($dc->table.'.pasteinto.1', [$row['id']], 'contao_'.$dc->table)), | ||
| $this->image->getHtml( | ||
| 'pasteinto.svg', | ||
| $this->translator->trans($dc->table.'.pasteinto.1', [$row['id']], 'contao_'.$dc->table) | ||
| ) | ||
| ); | ||
| } | ||
|
|
||
| /** @var PageModel $pageAdapter */ | ||
| $pageAdapter = $this->framework->getAdapter(PageModel::class); | ||
|
|
||
| $pageModel = $pageAdapter->findById($row['pid']); | ||
|
|
||
| // Do not show paste button for pages without content composition or articles in layout | ||
| if (null === $pageModel || !$this->supportsComposition($pageModel) || !$this->hasArticlesInLayout($pageModel)) { | ||
| return ''; | ||
| } | ||
|
|
||
| if ( | ||
| ($clipboard['mode'] === 'cut' && $clipboard['id'] === $row['id']) | ||
| || ($clipboard['mode'] === 'cutAll' && in_array($row['id'], $clipboard['id'])) | ||
| || !$user->isAllowed(BackendUser::CAN_EDIT_ARTICLE_HIERARCHY, $pageModel->row()) | ||
| || $cr | ||
| ) { | ||
| return $this->image->getHtml('pasteafter_.svg') . ' '; | ||
| } | ||
|
|
||
| return sprintf( | ||
| '<a href="%s" title="%s" onclick="Backend.getScrollOffset()">%s</a> ', | ||
| $this->backend->addToUrl('act=' . $clipboard['mode'] . '&mode=1&pid=' . $row['id'] . (!is_array($clipboard['id']) ? '&id=' . $clipboard['id'] : '')), | ||
| StringUtil::specialchars($this->translator->trans($dc->table.'.pasteafter.1', [$row['id']], 'contao_'.$dc->table)), | ||
| $this->image->getHtml( | ||
| 'pasteafter.svg', | ||
| $this->translator->trans($dc->table.'.pasteafter.1', [$row['id']], 'contao_'.$dc->table) | ||
| ) | ||
| ); | ||
| } | ||
|
|
||
| private function supportsComposition(PageModel $pageModel) | ||
| { | ||
| if (!$this->pageProviders->has($pageModel->type)) { | ||
| return true; | ||
| } | ||
|
|
||
| /** @var PageProviderInterface $provider */ | ||
| $provider = $this->pageProviders->get($pageModel->type); | ||
|
|
||
| return $provider->supportContentComposition($pageModel); | ||
| } | ||
|
|
||
| private function hasArticlesInLayout(PageModel $pageModel) | ||
| { | ||
| $pageModel->loadDetails(); | ||
|
|
||
| /** @var LayoutModel $layout */ | ||
| $layout = $pageModel->getRelated('layout'); | ||
|
|
||
| if (null === $layout) { | ||
| return false; | ||
| } | ||
|
|
||
| foreach (StringUtil::deserialize($layout->modules, true) as $config) { | ||
| if (0 === (int) $config['mod']) { | ||
| return true; | ||
| } | ||
| } | ||
|
|
||
| return false; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.