NGSTACK-977 tags visibility

bundle/API/Repository/TagsService.php

@@ -286,6 +286,22 @@ public function newSynonymCreateStruct(int $mainTagId, string $mainLanguageCode)
      */
     public function newTagUpdateStruct(): TagUpdateStruct;
 
+    /**
+     * Hides $tag.
+     *
+     * @throws \Ibexa\Contracts\Core\Repository\Exceptions\UnauthorizedException If the current user is not allowed to delete this tag
+     * @throws \Ibexa\Contracts\Core\Repository\Exceptions\NotFoundException If the specified tag is not found
+     */
+    public function hideTag(Tag $tag): void;
+
+    /**
+     * Unhides $tag.
+     *
+     * @throws \Ibexa\Contracts\Core\Repository\Exceptions\UnauthorizedException If the current user is not allowed to delete this tag
+     * @throws \Ibexa\Contracts\Core\Repository\Exceptions\NotFoundException If the specified tag is not found
+     */
+    public function unhideTag(Tag $tag): void;
+
     /**
      * Allows tags API execution to be performed with full access sand-boxed.
      *

bundle/API/Repository/Values/Tags/Tag.php

@@ -104,6 +104,16 @@ final class Tag extends ValueObject
      */
     protected ?string $prioritizedLanguageCode;
 
+    /**
+     * Indicates if the Tag object is visible or not
+     */
+    protected bool $isHidden;
+
+    /**
+     * Indicates if the Tag object is located under another hidden Tag object
+     */
+    protected bool $isInvisible;
+
     /**
      * Construct object optionally with a set of properties.
      *

bundle/Controller/Admin/TagController.php

@@ -500,9 +500,49 @@ public function childrenAction(Request $request, ?Tag $tag = null): Response
             );
         }
 
+        if ($request->request->has('HideTagsAction')) {
+            return $this->redirectToRoute(
+                'netgen_tags_admin_tag_hide_tags',
+                [
+                    'parentId' => $tag?->id ?? 0,
+                ],
+            );
+        }
+
+        if ($request->request->has('UnhideTagsAction')) {
+            return $this->redirectToRoute(
+                'netgen_tags_admin_tag_unhide_tags',
+                [
+                    'parentId' => $tag?->id ?? 0,
+                ],
+            );
+        }
+
         return $this->redirect($request->getPathInfo());
     }
 
+    public function hideAction(Request $request, Tag $tag): Response
+    {
+        $this->denyAccessUnlessGranted('ibexa:tags:hide' . ($tag->isSynonym() ? 'synonym' : ''));
+
+        $this->tagsService->hideTag($tag);
+
+        $this->addFlashMessage('success', 'tag_hidden', ['%tagKeyword%' => $tag->keyword]);
+
+        return $this->redirectToTag($tag);
+    }
+
+    public function unhideAction(Request $request, Tag $tag): Response
+    {
+        $this->denyAccessUnlessGranted('ibexa:tags:unhide' . ($tag->isSynonym() ? 'synonym' : ''));
+
+        $this->tagsService->unhideTag($tag);
+
+        $this->addFlashMessage('success', 'tag_unhidden', ['%tagKeyword%' => $tag->keyword]);
+
+        return $this->redirectToTag($tag);
+    }
+
     /**
      * This method is called from a form containing all children tags of a tag.
      * It shows a confirmation view.
@@ -666,6 +706,60 @@ public function deleteTagsAction(Request $request, ?Tag $parentTag = null): Resp
         );
     }
 
+    public function hideTagsAction(Request $request, ?Tag $parentTag = null): Response
+    {
+        $this->denyAccessUnlessGranted('ibexa:tags:hide');
+
+        $tagIds = (array) $request->request->get(
+            'Tags',
+            $request->hasSession() ? $request->getSession()->get('ngtags_tag_ids') : [],
+        );
+
+        if (count($tagIds) === 0) {
+            return $this->redirectToTag($parentTag);
+        }
+
+        $tags = [];
+        foreach ($tagIds as $tagId) {
+            $tags[] = $this->tagsService->loadTag((int) $tagId);
+        }
+
+        foreach ($tags as $tagObject) {
+            $this->tagsService->hideTag($tagObject);
+        }
+
+        $this->addFlashMessage('success', 'tags_hidden');
+
+        return $this->redirectToTag($parentTag);
+    }
+
+    public function unhideTagsAction(Request $request, ?Tag $parentTag = null): Response
+    {
+        $this->denyAccessUnlessGranted('ibexa:tags:unhide');
+
+        $tagIds = (array) $request->request->get(
+            'Tags',
+            $request->hasSession() ? $request->getSession()->get('ngtags_tag_ids') : [],
+        );
+
+        if (count($tagIds) === 0) {
+            return $this->redirectToTag($parentTag);
+        }
+
+        $tags = [];
+        foreach ($tagIds as $tagId) {
+            $tags[] = $this->tagsService->loadTag((int) $tagId);
+        }
+
+        foreach ($tags as $tagObject) {
+            $this->tagsService->unhideTag($tagObject);
+        }
+
+        $this->addFlashMessage('success', 'tags_unhidden');
+
+        return $this->redirectToTag($parentTag);
+    }
+
     public function searchTagsAction(Request $request): Response
     {
         $this->denyAccessUnlessGranted('ibexa:tags:read');

bundle/Controller/Admin/TreeController.php

@@ -126,6 +126,8 @@
             'parent' => $isRoot ? '#' : $tag->parentTagId,
             'text' => $synonymCount > 0 ? $this->escape($tag->keyword) . ' (+' . $synonymCount . ')' : $this->escape($tag->keyword),
             'children' => $this->tagsService->getTagChildrenCount($tag) > 0,
+            'hidden' => $tag->isHidden,
+            'invisible' => $tag->isInvisible,
             'a_attr' => [
                 'href' => str_replace(':tagId', (string) $tag->id, $this->treeLinks['show_tag']),
                 'rel' => $tag->id,

bundle/Controller/TagViewController.php

@@ -14,6 +14,14 @@
      */
     public function viewAction(TagView $view): TagView
     {
+        if ($view->getTag()->isHidden) {
+            throw $this->createNotFoundException('Tag is hidden.');
+        }
+
+        if ($view->getTag()->isInvisible) {
+            throw $this->createNotFoundException('Tag is hidden by parent.');
+        }
+
         return $view;
     }
 }

bundle/Core/Event/TagsService.php

@@ -226,6 +226,16 @@ public function newTagUpdateStruct(): TagUpdateStruct
         return $this->service->newTagUpdateStruct();
     }
 
+    public function hideTag(Tag $tag): void
+    {
+        $this->service->hideTag($tag);
+    }
+
+    public function unhideTag(Tag $tag): void
+    {
+        $this->service->unhideTag($tag);
+    }
+
     public function sudo(callable $callback, ?TagsServiceInterface $outerTagsService = null): mixed
     {
         return $this->service->sudo($callback, $outerTagsService ?? $this);

bundle/Core/Persistence/Cache/TagsHandler.php

@@ -304,6 +304,22 @@ public function deleteTag(int $tagId): void
         $this->cache->invalidateTags(['tag-path-' . $tagId]);
     }
 
+    public function hideTag(int $tagId): void
+    {
+        $this->logger->logCall(__METHOD__, ['tag' => $tagId]);
+        $this->tagsHandler->hideTag($tagId);
+
+        $this->cache->invalidateTags(['tag-path-' . $tagId]);
+    }
+
+    public function unhideTag(int $tagId): void
+    {
+        $this->logger->logCall(__METHOD__, ['tag' => $tagId]);
+        $this->tagsHandler->unhideTag($tagId);
+
+        $this->cache->invalidateTags(['tag-path-' . $tagId]);
+    }
+
     /**
      * Return relevant cache tags so cache can be purged reliably.
      *

bundle/Core/Persistence/Legacy/Tags/Gateway.php

@@ -112,4 +112,14 @@ abstract public function moveSubtree(array $sourceTagData, ?array $destinationPa
      * If $tagId is a synonym, only the synonym is deleted.
      */
     abstract public function deleteTag(int $tagId): void;
+
+    /**
+     * Hides tag identified by $tagId.
+     */
+    abstract public function hideTag(int $tagId): void;
+
+    /**
+     * Unhides tag identified by $tagId.
+     */
+    abstract public function unhideTag(int $tagId): void;
 }

bundle/Core/Persistence/Legacy/Tags/Gateway/DoctrineDatabase.php

@@ -844,6 +844,62 @@
         $query->execute();
     }
 
+    public function hideTag(int $tagId): void
+    {
+        $query = $this->connection->createQueryBuilder();
+        $query
+            ->update('eztags')
+            ->set('is_hidden', 1)
+            ->where(
+                $query->expr()->eq('id', ':tag_id'),
+            )->setParameter('tag_id', $tagId, Types::INTEGER);
+
+        $query->execute();
+
+        $query = $this->connection->createQueryBuilder();
+        $query
+            ->update('eztags')
+            ->set('is_invisible', 1)
+            ->where(
+                $query->expr()->like('path_string', ':path_string'),
+            )
+            ->andWhere(
+                $query->expr()->neq('id', ':tag_id'),
+            )
+            ->setParameter('path_string', '%/' . $tagId . '/%', Types::STRING)
+            ->setParameter('tag_id', $tagId, Types::INTEGER);
+
+        $query->execute();
+    }
+
+    public function unhideTag(int $tagId): void
+    {
+        $query = $this->connection->createQueryBuilder();
+        $query
+            ->update('eztags')
+            ->set('is_hidden', 0)
+            ->where(
+                $query->expr()->eq('id', ':tag_id'),
+            )->setParameter('tag_id', $tagId, Types::INTEGER);
+
+        $query->execute();
+
+        $query = $this->connection->createQueryBuilder();
+        $query
+            ->update('eztags')
+            ->set('is_invisible', 0)
+            ->where(
+                $query->expr()->like('path_string', ':path_string'),
+            )
+            ->andWhere(
+                $query->expr()->neq('id', ':tag_id'),
+            )
+            ->setParameter('path_string', '%/' . $tagId . '/%', Types::STRING)
+            ->setParameter('tag_id', $tagId, Types::INTEGER);
+
+        $query->execute();
+    }
+
     private function createTagIdsQuery(?array $translations = null, bool $useAlwaysAvailable = true): QueryBuilder
     {
         $query = $this->connection->createQueryBuilder();
@@ -930,6 +986,8 @@
             'eztags.remote_id',
             'eztags.main_language_id',
             'eztags.language_mask',
+            'eztags.is_hidden',
+            'eztags.is_invisible',
             // Tag keywords
             'eztags_keyword.keyword',
             'eztags_keyword.locale',

bundle/Core/Persistence/Legacy/Tags/Gateway/ExceptionConversion.php

@@ -224,4 +224,26 @@ public function deleteTag(int $tagId): void
             throw new RuntimeException('Database error', 0, $e);
         }
     }
+
+    public function hideTag(int $tagId): void
+    {
+        try {
+            $this->innerGateway->hideTag($tagId);
+        } catch (DBALException $e) {
+            throw new RuntimeException('Database error', 0, $e);
+        } catch (PDOException $e) {
+            throw new RuntimeException('Database error', 0, $e);
+        }
+    }
+
+    public function unhideTag(int $tagId): void
+    {
+        try {
+            $this->innerGateway->unhideTag($tagId);
+        } catch (DBALException $e) {
+            throw new RuntimeException('Database error', 0, $e);
+        } catch (PDOException $e) {
+            throw new RuntimeException('Database error', 0, $e);
+        }
+    }
 }

bundle/Core/Persistence/Legacy/Tags/Handler.php

@@ -219,6 +219,18 @@ public function deleteTag(int $tagId): void
         $this->gateway->deleteTag($tagInfo->id);
     }
 
+    public function hideTag(int $tagId): void
+    {
+        $tagInfo = $this->loadTagInfo($tagId);
+        $this->gateway->hideTag($tagInfo->id);
+    }
+
+    public function unhideTag(int $tagId): void
+    {
+        $tagInfo = $this->loadTagInfo($tagId);
+        $this->gateway->unhideTag($tagInfo->id);
+    }
+
     /**
      * Copies tag object identified by $sourceData into destination identified by $destinationParentData.
      *

bundle/Core/Persistence/Legacy/Tags/Mapper.php

@@ -35,6 +35,8 @@ public function createTagInfoFromRow(array $row): TagInfo
         $tagInfo->alwaysAvailable = (bool) ((int) $row['language_mask'] & 1);
         $tagInfo->mainLanguageCode = $this->languageHandler->load($row['main_language_id'])->languageCode;
         $tagInfo->languageIds = $this->languageMaskGenerator->extractLanguageIdsFromMask((int) $row['language_mask']);
+        $tagInfo->isHidden = (bool) ((int) $row['is_hidden']);
+        $tagInfo->isInvisible = (bool) ((int) $row['is_invisible']);
 
         return $tagInfo;
     }
@@ -60,6 +62,8 @@ public function extractTagListFromRows(array $rows): array
                 $tag->alwaysAvailable = (bool) ((int) $row['language_mask'] & 1);
                 $tag->mainLanguageCode = $this->languageHandler->load($row['main_language_id'])->languageCode;
                 $tag->languageIds = $this->languageMaskGenerator->extractLanguageIdsFromMask((int) $row['language_mask']);
+                $tag->isHidden = (bool) ((int) $row['is_hidden']);
+                $tag->isInvisible = (bool) ((int) $row['is_invisible']);
                 $tagList[$tagId] = $tag;
             }
 

bundle/Core/Repository/TagsMapper.php

@@ -67,6 +67,8 @@ public function buildTagDomainList(array $spiTags, array $prioritizedLanguages =
                     'mainLanguageCode' => $spiTag->mainLanguageCode,
                     'languageCodes' => $languageCodes,
                     'prioritizedLanguageCode' => $prioritizedLanguageCode,
+                    'isHidden' => $spiTag->isHidden,
+                    'isInvisible' => $spiTag->isInvisible,
                 ],
             );
         }