π₯π₯π₯ Open-source Jira, Linear, Monday, and ClickUp alternative. Plane is a modern project management platform to manage tasks, sprints, docs, and triage.
TypeScript boardsbug-trackerdjangodockerganttissue-trackerjirajira-alternativekanbanlinearpostgresqlproduct-managementproject-managementproject-planningpythonreactredistypesciptvitework-management
[WEB-5878] chore: add validation for project name/identifier for special characters (#8529)
Sangeethac4b3d5246643
diff --git a/apps/api/plane/api/serializers/project.py b/apps/api/plane/api/serializers/project.pyindex 01ccf9434d..644b5ba107 100644--- a/apps/api/plane/api/serializers/project.py+++ b/apps/api/plane/api/serializers/project.py@@ -6,6 +6,10 @@import randomfrom rest_framework import serializers++# Python imports+import re+# Module importsfrom plane.db.models import Project, ProjectIdentifier, WorkspaceMember, State, Estimate@@ -101,6 +105,15 @@ class ProjectCreateSerializer(BaseSerializer):]def validate(self, data):+ project_name = data.get("name", None)+ project_identifier = data.get("identifier", None)++ if project_name is not None and re.match(Project.FORBIDDEN_IDENTIFIER_CHARS_PATTERN, project_name):+ raise serializers.ValidationError("Project name cannot contain special characters.")++ if project_identifier is not None and re.match(Project.FORBIDDEN_IDENTIFIER_CHARS_PATTERN, project_identifier):+ raise serializers.ValidationError("Project identifier cannot contain special characters.")+if data.get("project_lead", None) is not None:# Check if the project lead is a member of the workspaceif not WorkspaceMember.objects.filter(@@ -160,6 +173,15 @@ class ProjectUpdateSerializer(ProjectCreateSerializer):read_only_fields = ProjectCreateSerializer.Meta.read_only_fieldsdef update(self, instance, validated_data):+ project_name = validated_data.get("name", None)+ project_identifier = validated_data.get("identifier", None)++ if project_name is not None and re.match(Project.FORBIDDEN_IDENTIFIER_CHARS_PATTERN, project_name):+ raise serializers.ValidationError("Project name cannot contain special characters.")++ if project_identifier is not None and re.match(Project.FORBIDDEN_IDENTIFIER_CHARS_PATTERN, project_identifier):+ raise serializers.ValidationError("Project identifier cannot contain special characters.")+"""Update a project"""if (validated_data.get("default_state", None) is not None@@ -210,6 +232,15 @@ class ProjectSerializer(BaseSerializer):]def validate(self, data):+ project_name = data.get("name", None)+ project_identifier = data.get("identifier", None)++ if project_name is not None and re.match(Project.FORBIDDEN_IDENTIFIER_CHARS_PATTERN, project_name):+ raise serializers.ValidationError("Project name cannot contain special characters.")++ if project_identifier is not None and re.match(Project.FORBIDDEN_IDENTIFIER_CHARS_PATTERN, project_identifier):+ raise serializers.ValidationError("Project identifier cannot contain special characters.")+# Check project lead should be a member of the workspaceif (data.get("project_lead", None) is not Nonediff --git a/apps/api/plane/app/serializers/project.py b/apps/api/plane/app/serializers/project.pyindex 77d7dc658e..924c48fcfa 100644--- a/apps/api/plane/app/serializers/project.py+++ b/apps/api/plane/app/serializers/project.py@@ -5,6 +5,9 @@# Third party importsfrom rest_framework import serializers+# Python imports+import re+# Module importsfrom .base import BaseSerializer, DynamicBaseSerializerfrom django.db.models import Max@@ -37,6 +40,9 @@ class ProjectSerializer(BaseSerializer):project_id = self.instance.id if self.instance else Noneworkspace_id = self.context["workspace_id"]+ if re.match(Project.FORBIDDEN_IDENTIFIER_CHARS_PATTERN, name):+ raise serializers.ValidationError(detail="PROJECT_NAME_CANNOT_CONTAIN_SPECIAL_CHARACTERS")+project = Project.objects.filter(name=name, workspace_id=workspace_id)if project_id:@@ -53,6 +59,9 @@ class ProjectSerializer(BaseSerializer):project_id = self.instance.id if self.instance else Noneworkspace_id = self.context["workspace_id"]+ if re.match(Project.FORBIDDEN_IDENTIFIER_CHARS_PATTERN, identifier):+ raise serializers.ValidationError(detail="PROJECT_IDENTIFIER_CANNOT_CONTAIN_SPECIAL_CHARACTERS")+project = Project.objects.filter(identifier=identifier, workspace_id=workspace_id)if project_id:diff --git a/apps/api/plane/db/models/project.py b/apps/api/plane/db/models/project.pyindex 148bd08fc6..4039b1d290 100644--- a/apps/api/plane/db/models/project.py+++ b/apps/api/plane/db/models/project.py@@ -140,6 +140,8 @@ class Project(BaseModel):"""Return name of the project"""return f"{self.name} <{self.workspace.name}>"+ FORBIDDEN_IDENTIFIER_CHARS_PATTERN = r"^.*[&+,:;$^}{*=?@#|'<>.()%!-].*$"+class Meta:unique_together = [["identifier", "workspace", "deleted_at"],