Release 2.23.0 (#5075)

This commit is contained in:
Kevin Papst
2024-10-03 10:34:20 +02:00
committed by GitHub
parent 40154be8f9
commit fb9a0dc499
142 changed files with 855 additions and 910 deletions

View File

@@ -22,7 +22,6 @@ use Symfony\Component\Form\FormInterface;
use Symfony\Component\Form\FormTypeInterface;
use Symfony\Component\HttpFoundation\RedirectResponse;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Session\SessionInterface;
use Symfony\Contracts\Service\ServiceSubscriberInterface;
use Symfony\Contracts\Translation\TranslatorInterface;
@@ -229,35 +228,15 @@ abstract class AbstractController extends BaseAbstractController implements Serv
return $this->container->get(BookmarkRepository::class);
}
private function getLastSearch(SessionInterface $session, BaseQuery $query): ?array
{
$name = 'search_' . $this->getSearchName($query);
if (!$session->has($name)) {
return null;
}
return $session->get($name);
}
private function removeLastSearch(SessionInterface $session, BaseQuery $query): void
{
$name = 'search_' . $this->getSearchName($query);
if ($session->has($name)) {
$session->remove($name);
}
}
private function getSearchName(BaseQuery $query): string
{
return substr($query->getName(), 0, 50);
}
/**
* Use "performSearch=1" to skip loading session searches.
* Use "performSearch=1" to skip loading bookmarked searches.
*
* @param array<string> $filterParams parameter names, which should not be saved (neither session, nor database)
* @param array<string> $filterParams parameter names, which should not be persisted with bookmark
* @throws \Exception
*/
protected function handleSearch(FormInterface $form, Request $request, array $filterParams = []): bool
@@ -267,7 +246,7 @@ abstract class AbstractController extends BaseAbstractController implements Serv
throw new \InvalidArgumentException('handleSearchForm() requires an instanceof BaseQuery as form data');
}
$actions = ['resetSearchFilter', 'removeDefaultQuery', 'setDefaultQuery'];
$actions = ['removeDefaultQuery', 'setDefaultQuery'];
foreach ($actions as $action) {
if ($request->query->has($action)) {
if (!$this->isCsrfTokenValid('search', $request->query->get('_token'))) {
@@ -280,13 +259,6 @@ abstract class AbstractController extends BaseAbstractController implements Serv
$request->query->remove('_token');
if ($request->query->has('resetSearchFilter')) {
$data->resetFilter();
$this->removeLastSearch($request->getSession(), $data);
return true;
}
$queryKey = null;
if (!empty($formName = $form->getConfig()->getName()) && $request->request->has($formName)) {
// allow using forms with block-prefix
@@ -300,40 +272,14 @@ abstract class AbstractController extends BaseAbstractController implements Serv
}
$searchName = $this->getSearchName($data);
$bookmarkRepo = $this->getBookmark();
$bookmark = $bookmarkRepo->getSearchDefaultOptions($this->getUser(), $searchName);
if ($bookmark !== null) {
if ($request->query->has('removeDefaultQuery')) {
if ($request->query->has('removeDefaultQuery')) {
$bookmarkRepo = $this->getBookmark();
$bookmark = $bookmarkRepo->getSearchDefaultOptions($this->getUser(), $searchName);
if ($bookmark !== null) {
$bookmarkRepo->deleteBookmark($bookmark);
$bookmark = null;
return true;
} else {
$data->setBookmark($bookmark);
}
}
// apply persisted search data ONLY if search form was not submitted manually
if (!$request->query->has('performSearch')) {
$sessionSearch = $this->getLastSearch($request->getSession(), $data);
if ($sessionSearch !== null) {
$submitData = array_merge($sessionSearch, $submitData);
} elseif ($bookmark !== null && !$request->query->has('setDefaultQuery')) {
$bookContent = $bookmark->getContent();
$isBookmarkSearch = true;
foreach ($submitData as $key => $value) {
if (!\array_key_exists($key, $bookContent) || $value !== $bookContent[$key]) {
$isBookmarkSearch = false;
break;
}
}
if ($isBookmarkSearch) {
$data->flagAsBookmarkSearch();
}
$submitData = array_merge($bookContent, $submitData);
}
return true;
}
// clean up parameters from unknown search values
@@ -343,6 +289,26 @@ abstract class AbstractController extends BaseAbstractController implements Serv
}
}
if (\count($submitData) === 0) {
$bookmark = $this->getBookmark()->getSearchDefaultOptions($this->getUser(), $searchName);
$data->setBookmark($bookmark);
// apply persisted search data ONLY if search form was not submitted manually
if ($bookmark !== null && !$request->query->has('performSearch') && !$request->query->has('setDefaultQuery')) {
$bookContent = $bookmark->getContent();
$data->flagAsBookmarkSearch();
// clean up parameters from unknown search values that were stored in an old bookmark
foreach ($bookContent as $name => $values) {
if (!$form->has($name)) {
unset($bookContent[$name]);
}
}
$submitData = $bookContent;
}
}
$form->submit($submitData, false);
if (!$form->isValid()) {
@@ -357,19 +323,7 @@ abstract class AbstractController extends BaseAbstractController implements Serv
}
// these should NEVER be saved
$filter = array_merge(['setDefaultQuery', 'removeDefaultQuery', 'performSearch'], $filterParams);
foreach ($filter as $name) {
if (isset($params[$name])) {
unset($params[$name]);
}
}
if ($request->query->has('performSearch')) {
$request->getSession()->set('search_' . $searchName, $params);
}
// filter stuff, that does not belong in a bookmark
$filter = ['page'];
$filter = array_merge(['setDefaultQuery', 'removeDefaultQuery', 'performSearch', 'page'], $filterParams);
foreach ($filter as $name) {
if (isset($params[$name])) {
unset($params[$name]);
@@ -377,7 +331,8 @@ abstract class AbstractController extends BaseAbstractController implements Serv
}
if ($request->query->has('setDefaultQuery')) {
$this->removeLastSearch($request->getSession(), $data);
$bookmark = $this->getBookmark()->getSearchDefaultOptions($this->getUser(), $searchName);
if ($bookmark === null) {
$bookmark = new Bookmark();
$bookmark->setType(Bookmark::SEARCH_DEFAULT);
@@ -386,7 +341,7 @@ abstract class AbstractController extends BaseAbstractController implements Serv
}
$bookmark->setContent($params);
$bookmarkRepo->saveBookmark($bookmark);
$this->getBookmark()->saveBookmark($bookmark);
return true;
}