feat: sitemap 클릭 시 외부 링크로 갈 수 있도록 기능 추가

MU-Software · MU-Software · commit cec6763a35ce · 2025-06-21T21:12:19.000+09:00
diff --git a/app/admin_api/serializers/cms.py b/app/admin_api/serializers/cms.py
@@ -1,3 +1,5 @@
+import re
+
 from cms.models import Page, Section, Sitemap
 from core.const.serializer import COMMON_ADMIN_FIELDS
 from core.serializer.base_abstract_serializer import BaseAbstractSerializer
@@ -8,25 +10,64 @@
 class SitemapAdminSerializer(BaseAbstractSerializer, JsonSchemaSerializer, serializers.ModelSerializer):
     class Meta:
         model = Sitemap
-        fields = COMMON_ADMIN_FIELDS + ("parent_sitemap", "route_code", "order", "page", "name_ko", "name_en", "hide")
+        fields = COMMON_ADMIN_FIELDS + (
+            "parent_sitemap",
+            "route_code",
+            "order",
+            "page",
+            "external_link",
+            "is_frontend_page",
+            "name_ko",
+            "name_en",
+            "hide",
+        )
+
+    def validate_route_code(self, value: str) -> str:
+        if not re.match(r"^[a-zA-Z0-9_-]*$", value):
+            raise serializers.ValidationError("route_code는 알파벳, 숫자, 언더바(_)로만 구성되어야 합니다.")
+
+        return value
+
+    def validate_external_link(self, value: str | None) -> str | None:
+        # 빈 string인 경우 None으로 처리
+        return value or None
+
+    def validate_parent_sitemap(self, value: Sitemap | None) -> Sitemap | None:
+        if not value:
+            return None
+
+        if parent_sitemap := self.instance:
+            while parent_sitemap:
+                if value == parent_sitemap:
+                    raise serializers.ValidationError("Parent Sitemap이 본인 또는 자식 Sitemap을 가리킬 수 없습니다.")
+                parent_sitemap = parent_sitemap.parent_sitemap
+
+        return value
+
+    def validate(self, attrs: dict) -> dict:
+        page = attrs.get("page", getattr(self.instance, "page", None))
+        external_link = attrs.get("external_link", getattr(self.instance, "external_link", None))
+        is_frontend_page = attrs.get("is_frontend_page", getattr(self.instance, "is_frontend_page", False))
+
+        if not (page or external_link or is_frontend_page):
+            raise serializers.ValidationError(
+                "Page 또는 External Link, is_frontend_page 중 하나는 반드시 선택 또는 입력해야 합니다."
+            )
+        if len([v for v in (page, external_link, is_frontend_page) if v]) > 1:
+            raise serializers.ValidationError("Page, External Link, is_frontend_page 중 하나만 선택할 수 있습니다.")
+
+        return attrs
 
 
 class PageAdminSerializer(BaseAbstractSerializer, JsonSchemaSerializer, serializers.ModelSerializer):
     class Meta:
         model = Page
-        fields = COMMON_ADMIN_FIELDS + (
-            "title_ko",
-            "title_en",
-            "subtitle_ko",
-            "subtitle_en",
-            "show_top_title_banner",
-            "show_bottom_sponsor_banner",
-        )
+        fields = COMMON_ADMIN_FIELDS + ("title_ko", "title_en", "show_top_title_banner", "show_bottom_sponsor_banner")
 
 
 class SectionAdminSerializer(BaseAbstractSerializer, JsonSchemaSerializer, serializers.ModelSerializer):
     page = serializers.PrimaryKeyRelatedField(queryset=Page.objects.filter_active(), required=False)
 
     class Meta:
         model = Section
-        fields = COMMON_ADMIN_FIELDS + ("page", "order", "body_ko", "body_en")
+        fields = COMMON_ADMIN_FIELDS + ("page", "external_link", "order", "body_ko", "body_en")
diff --git a/app/cms/migrations/0009_historicalsitemap_external_link_and_more.py b/app/cms/migrations/0009_historicalsitemap_external_link_and_more.py
@@ -0,0 +1,73 @@
+# Generated by Django 5.2 on 2025-06-21 12:11
+
+import django.db.models.deletion
+from django.conf import settings
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("cms", "0008_historicalsitemap_hide_sitemap_hide"),
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="historicalsitemap",
+            name="external_link",
+            field=models.URLField(
+                blank=True, help_text="외부 링크인 경우 Page를 지정하는 대신 URL을 입력하세요.", null=True
+            ),
+        ),
+        migrations.AddField(
+            model_name="historicalsitemap",
+            name="is_frontend_page",
+            field=models.BooleanField(
+                default=False, help_text="만약 이 Sitemap이 프론트엔드에 하드코딩된 페이지라면 체크하세요."
+            ),
+        ),
+        migrations.AddField(
+            model_name="sitemap",
+            name="external_link",
+            field=models.URLField(
+                blank=True, help_text="외부 링크인 경우 Page를 지정하는 대신 URL을 입력하세요.", null=True
+            ),
+        ),
+        migrations.AddField(
+            model_name="sitemap",
+            name="is_frontend_page",
+            field=models.BooleanField(
+                default=False, help_text="만약 이 Sitemap이 프론트엔드에 하드코딩된 페이지라면 체크하세요."
+            ),
+        ),
+        migrations.AlterField(
+            model_name="historicalsitemap",
+            name="page",
+            field=models.ForeignKey(
+                blank=True,
+                db_constraint=False,
+                help_text="Sitemap 클릭 시 보여질 Page",
+                null=True,
+                on_delete=django.db.models.deletion.DO_NOTHING,
+                related_name="+",
+                to="cms.page",
+            ),
+        ),
+        migrations.AlterField(
+            model_name="sitemap",
+            name="page",
+            field=models.ForeignKey(
+                blank=True,
+                help_text="Sitemap 클릭 시 보여질 Page",
+                null=True,
+                on_delete=django.db.models.deletion.PROTECT,
+                to="cms.page",
+            ),
+        ),
+        migrations.AddConstraint(
+            model_name="sitemap",
+            constraint=models.UniqueConstraint(
+                fields=("parent_sitemap", "route_code"), name="uq__sitemap__parent_route_code"
+            ),
+        ),
+    ]
diff --git a/app/cms/models.py b/app/cms/models.py
@@ -84,7 +84,17 @@ class Sitemap(BaseAbstractModel):
     route_code = models.CharField(max_length=256, blank=True)
     name = models.CharField(max_length=256)
     order = models.IntegerField(default=0, validators=[MinValueValidator(0)])
-    page = models.ForeignKey(Page, on_delete=models.PROTECT)
+
+    page = models.ForeignKey(
+        Page, on_delete=models.PROTECT, null=True, blank=True, help_text="Sitemap 클릭 시 보여질 Page"
+    )
+    external_link = models.URLField(
+        null=True, blank=True, help_text="외부 링크인 경우 Page를 지정하는 대신 URL을 입력하세요."
+    )
+    is_frontend_page = models.BooleanField(
+        default=False, help_text="만약 이 Sitemap이 프론트엔드에 하드코딩된 페이지라면 체크하세요."
+    )
+
     hide = models.BooleanField(default=False, help_text="이 Sitemap을 숨길지 여부")
 
     display_start_at = models.DateTimeField(null=True, blank=True)
@@ -94,6 +104,9 @@ class Sitemap(BaseAbstractModel):
 
     class Meta:
         ordering = ["order"]
+        constraints = [
+            models.UniqueConstraint(fields=["parent_sitemap", "route_code"], name="uq__sitemap__parent_route_code"),
+        ]
 
     def __str__(self):
         return f"{self.route} ({self.name})"
diff --git a/app/cms/serializers.py b/app/cms/serializers.py
@@ -6,7 +6,15 @@
 class SitemapSerializer(serializers.ModelSerializer):
     class Meta:
         model = Sitemap
-        fields = COMMON_FIELDS + ("parent_sitemap", "route_code", "name", "order", "page", "hide")
+        fields = COMMON_FIELDS + (
+            "parent_sitemap",
+            "route_code",
+            "name",
+            "order",
+            "page",
+            "external_link",
+            "hide",
+        )
 
 
 class SectionSerializer(serializers.ModelSerializer):
