[shopsys] Change blog categories for real root category (#3595)

Co-authored-by: Michal Vanek <michal.vanek@shopsys.com>
shopsys · Nov 19, 2024 · b64f6f6 · b64f6f6
1 parent 804ed76
commit b64f6f6
Show file tree

Hide file tree

Showing 9 changed files with 113 additions and 19 deletions.
diff --git a/assets/js/admin/components/CategoryTreeSorting.js b/assets/js/admin/components/CategoryTreeSorting.js
@@ -34,6 +34,7 @@ export default class CategoryTreeSorting {
             helper: 'clone',
             opacity: 0.6,
             revert: 100,
+            protectRoot: this.$rootTree.hasClass('js-protect-root'),
             change: () => _this.onChange()
         });
 

diff --git a/src/Form/Admin/Blog/BlogCategoryFormType.php b/src/Form/Admin/Blog/BlogCategoryFormType.php
@@ -135,7 +135,7 @@ private function createSettingsGroup(FormBuilderInterface $builder, array $optio
                 'required' => true,
                 'choices' => $parentChoices,
                 'choice_label' => function (BlogCategory $blogCategory) {
-                    $padding = str_repeat("\u{00a0}", ($blogCategory->getLevel() - 1) * 2);
+                    $padding = str_repeat("\u{00a0}", $blogCategory->getLevel() * 2);
 
                     return $padding . $blogCategory->getName();
                 },

diff --git a/src/Migrations/Version20241112100245.php b/src/Migrations/Version20241112100245.php
@@ -0,0 +1,53 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Shopsys\FrameworkBundle\Migrations;
+
+use Doctrine\DBAL\Schema\Schema;
+use Exception;
+use Gedmo\Tree\Entity\Repository\NestedTreeRepository;
+use Shopsys\FrameworkBundle\Model\Blog\Category\BlogCategory;
+use Shopsys\MigrationBundle\Component\Doctrine\Migrations\AbstractMigration;
+use Symfony\Component\DependencyInjection\ContainerAwareInterface;
+
+class Version20241112100245 extends AbstractMigration implements ContainerAwareInterface
+{
+    use MultidomainMigrationTrait;
+
+    /**
+     * @param \Doctrine\DBAL\Schema\Schema $schema
+     */
+    public function up(Schema $schema): void
+    {
+        $rootBlogCategories = $this->sql('SELECT id FROM blog_categories WHERE parent_id IS NULL AND level = 0')->fetchAllAssociative();
+
+        if (count($rootBlogCategories) === 1) {
+            $blogCategoryId = reset($rootBlogCategories)['id'];
+            $translation = $this->sql('SELECT 1 FROM blog_category_translations WHERE translatable_id = ?', [$blogCategoryId])->fetchOne();
+
+            if ($translation === false) {
+                $this->sql('UPDATE blog_categories SET parent_id = NULL WHERE parent_id = ?', [$blogCategoryId]);
+                $this->sql('DELETE FROM blog_category_domains WHERE blog_category_id = ?', [$blogCategoryId]);
+                $this->sql('DELETE FROM blog_categories WHERE id = ?', [$blogCategoryId]);
+                $this->sql('UPDATE blog_categories SET level = level -1');
+            }
+
+            $entityManager = $this->container->get('doctrine.orm.default_entity_manager');
+            $repository = $entityManager->getRepository(BlogCategory::class);
+
+            if ($repository instanceof NestedTreeRepository) {
+                $repository->recover();
+            }
+        } elseif (count($rootBlogCategories) > 1) {
+            throw new Exception('There is more than one root blog category. Please see upgrade notes.');
+        }
+    }
+
+    /**
+     * @param \Doctrine\DBAL\Schema\Schema $schema
+     */
+    public function down(Schema $schema): void
+    {
+    }
+}
diff --git a/src/Model/Blog/Category/BlogCategory.php b/src/Model/Blog/Category/BlogCategory.php
@@ -20,8 +20,6 @@
  */
 class BlogCategory extends AbstractTranslatableEntity
 {
-    public const BLOG_MAIN_PAGE_CATEGORY_ID = 2;
-
     /**
      * @var int
      * @ORM\Column(type="integer")
@@ -336,7 +334,7 @@ public function createDomains(BlogCategoryData $blogCategoryData): void
      */
     public function isMainPage()
     {
-        return $this->id === self::BLOG_MAIN_PAGE_CATEGORY_ID;
+        return $this->parent === null;
     }
 
     /**

diff --git a/src/Model/Blog/Category/BlogCategoryFacade.php b/src/Model/Blog/Category/BlogCategoryFacade.php
@@ -14,11 +14,10 @@
 use Shopsys\FrameworkBundle\Model\Blog\Article\Elasticsearch\BlogArticleExportQueueFacade;
 use Shopsys\FrameworkBundle\Model\Blog\BlogVisibilityRecalculationScheduler;
 use Shopsys\FrameworkBundle\Model\Blog\Category\Exception\BlogCategoryNotFoundException;
+use Shopsys\FrameworkBundle\Model\Blog\Category\Exception\RootLevelBlogCategoryAlreadyExistsException;
 
 class BlogCategoryFacade
 {
-    protected const INCREMENT_DUE_TO_MISSING_ROOT_CATEGORY = 1;
-
     /**
      * @param \Doctrine\ORM\EntityManagerInterface $em
      * @param \Shopsys\FrameworkBundle\Model\Blog\Category\BlogCategoryRepository $blogCategoryRepository
@@ -65,6 +64,10 @@ public function create(BlogCategoryData $blogCategoryData): BlogCategory
         $rootCategory = $this->getRootBlogCategory();
         $blogCategory = $this->blogCategoryFactory->create($blogCategoryData, $rootCategory);
 
+        if ($blogCategory->getParent() === null) {
+            throw new RootLevelBlogCategoryAlreadyExistsException($rootCategory->getId());
+        }
+
         $this->em->persist($blogCategory);
         $this->em->flush();
 
@@ -93,7 +96,7 @@ public function edit(int $blogCategoryId, BlogCategoryData $blogCategoryData): B
         $blogCategory = $this->blogCategoryRepository->getById($blogCategoryId);
         $blogCategory->edit($blogCategoryData);
 
-        if ($blogCategory->getParent() === null) {
+        if ($blogCategory->getParent() === null && $rootCategory !== $blogCategory) {
             $blogCategory->setParent($rootCategory);
         }
 
@@ -187,6 +190,15 @@ public function getVisibleBlogCategoriesInPathFromRootOnDomain(BlogCategory $blo
         return $this->blogCategoryRepository->getVisibleBlogCategoriesInPathFromRootOnDomain($blogCategory, $domainId);
     }
 
+    /**
+     * @param int $domainId
+     * @return \Shopsys\FrameworkBundle\Model\Blog\Category\BlogCategory[]
+     */
+    public function getAllVisibleChildrenWithRootByDomainId(int $domainId): array
+    {
+        return $this->blogCategoryRepository->getAllVisibleChildrenWithRootByDomainId($domainId);
+    }
+
     /**
      * @param \Shopsys\FrameworkBundle\Model\Blog\Category\BlogCategory $category
      * @param int $domainId
@@ -307,10 +319,10 @@ public function reorderByNestedSetValues(array $blogCategoriesOrderingData): voi
         foreach ($blogCategoriesOrderingData as $categoryOrderingData) {
             $query->execute([
                 'id' => (int)$categoryOrderingData['id'],
-                'parent' => $categoryOrderingData['parent_id'] ? (int)$categoryOrderingData['parent_id'] : $rootCategoryId,
-                'level' => $categoryOrderingData['depth'] + static::INCREMENT_DUE_TO_MISSING_ROOT_CATEGORY,
-                'lft' => $categoryOrderingData['left'] + static::INCREMENT_DUE_TO_MISSING_ROOT_CATEGORY,
-                'rgt' => $categoryOrderingData['right'] + static::INCREMENT_DUE_TO_MISSING_ROOT_CATEGORY,
+                'parent' => (int)$categoryOrderingData['id'] === $rootCategoryId ? null : ($categoryOrderingData['parent_id'] ? (int)$categoryOrderingData['parent_id'] : $rootCategoryId),
+                'level' => $categoryOrderingData['depth'],
+                'lft' => $categoryOrderingData['left'],
+                'rgt' => $categoryOrderingData['right'],
             ]);
         }
 

diff --git a/src/Model/Blog/Category/BlogCategoryRepository.php b/src/Model/Blog/Category/BlogCategoryRepository.php
@@ -45,7 +45,6 @@ protected function getAllQueryBuilder(): QueryBuilder
     {
         return $this->getBlogCategoryRepository()
             ->createQueryBuilder('bc')
-            ->where('bc.parent IS NOT NULL')
             ->orderBy('bc.lft');
     }
 
@@ -111,10 +110,6 @@ public function findById(int $blogCategoryId): ?BlogCategory
         /** @var \Shopsys\FrameworkBundle\Model\Blog\Category\BlogCategory $blogCategory */
         $blogCategory = $this->getBlogCategoryRepository()->find($blogCategoryId);
 
-        if ($blogCategory !== null && $blogCategory->getParent() === null) {
-            return null;
-        }
-
         return $blogCategory;
     }
 
@@ -173,7 +168,6 @@ protected function getPreOrderTreeTraversalForAllBlogCategoriesQueryBuilder(stri
         $this->addTranslation($queryBuilder, $locale);
 
         $queryBuilder
-            ->andWhere('bc.level >= 1')
             ->orderBy('bc.lft');
 
         return $queryBuilder;
@@ -207,6 +201,21 @@ public function getAllVisibleByDomainIdQueryBuilder(int $domainId): QueryBuilder
         return $queryBuilder;
     }
 
+    /**
+     * @param int $domainId
+     * @return \Shopsys\FrameworkBundle\Model\Blog\Category\BlogCategory[]
+     */
+    public function getAllVisibleChildrenWithRootByDomainId(int $domainId): array
+    {
+        $queryBuilder = $this->getAllVisibleByDomainIdQueryBuilder($domainId)
+            ->andWhere('bc.parent IS NULL');
+
+        $locale = $this->domain->getDomainConfigById($domainId)->getLocale();
+        $this->addTranslation($queryBuilder, $locale);
+
+        return $queryBuilder->getQuery()->execute();
+    }
+
     /**
      * @param \Shopsys\FrameworkBundle\Model\Blog\Category\BlogCategory $blogCategory
      * @param int $domainId

diff --git a/src/Model/Blog/Category/BlogCategoryWithPreloadedChildrenFactory.php b/src/Model/Blog/Category/BlogCategoryWithPreloadedChildrenFactory.php
@@ -55,7 +55,7 @@ protected function getFirstLevelBlogCategories(array $blogCategories): array
         $firstLevelBlogCategories = [];
 
         foreach ($blogCategories as $blogCategory) {
-            if ($blogCategory->getLevel() === 1) {
+            if ($blogCategory->getLevel() === 0) {
                 $firstLevelBlogCategories[] = $blogCategory;
             }
         }

diff --git a/src/Model/Blog/Category/Exception/RootLevelBlogCategoryAlreadyExistsException.php b/src/Model/Blog/Category/Exception/RootLevelBlogCategoryAlreadyExistsException.php
@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Shopsys\FrameworkBundle\Model\Blog\Category\Exception;
+
+use Exception;
+
+class RootLevelBlogCategoryAlreadyExistsException extends Exception
+{
+    /**
+     * @param int $blogCategoryId
+     * @param \Exception|null $previous
+     */
+    public function __construct(int $blogCategoryId, ?Exception $previous = null)
+    {
+        $message = sprintf('There can be only one blog category with root level. The current root level blog category ID is "%d".', $blogCategoryId);
+
+        parent::__construct($message, 0, $previous);
+    }
+}
diff --git a/src/Resources/views/Admin/Content/Blog/Category/list.html.twig b/src/Resources/views/Admin/Content/Blog/Category/list.html.twig
@@ -32,7 +32,7 @@
                                 id: blogCategoryWithPreloadedChildren.blogCategory.id,
                                 (constant('Shopsys\\FrameworkBundle\\Component\\Router\\Security\\RouteCsrfProtector::CSRF_TOKEN_REQUEST_PARAMETER')): csrf_token(csrfTokenId)
                             }) %}
-                            {% if blogCategoryWithPreloadedChildren.blogCategory.level is not same as(1) %}
+                            {% if blogCategoryWithPreloadedChildren.blogCategory.level is not same as(0) %}
                                 <a
                                     data-delete-url="{{ blogCategoryDeleteUrl }}"
                                     class="form-tree__item__control js-category-delete-confirm"