425 lines
16 KiB
Python
425 lines
16 KiB
Python
# Copyright (C) 2014 Andrey Antukh <niwi@niwi.be>
|
|
# Copyright (C) 2014 Jesús Espino <jespinog@gmail.com>
|
|
# Copyright (C) 2014 David Barragán <bameda@dbarragan.com>
|
|
# This program is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU Affero General Public License as
|
|
# published by the Free Software Foundation, either version 3 of the
|
|
# License, or (at your option) any later version.
|
|
#
|
|
# This program is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU Affero General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU Affero General Public License
|
|
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
|
|
from django.utils.translation import ugettext as _
|
|
from django.db.models import Q
|
|
|
|
from taiga.base.api import serializers
|
|
|
|
from taiga.base.fields import JsonField
|
|
from taiga.base.fields import PgArrayField
|
|
from taiga.base.fields import TagsField
|
|
from taiga.base.fields import TagsColorsField
|
|
|
|
from taiga.projects.notifications.validators import WatchersValidator
|
|
|
|
from taiga.users.services import get_photo_or_gravatar_url
|
|
from taiga.users.serializers import UserSerializer
|
|
from taiga.users.serializers import UserBasicInfoSerializer
|
|
from taiga.users.serializers import ProjectRoleSerializer
|
|
from taiga.users.validators import RoleExistsValidator
|
|
|
|
from taiga.permissions.service import get_user_project_permissions
|
|
from taiga.permissions.service import is_project_owner
|
|
|
|
from . import models
|
|
from . import services
|
|
from .validators import ProjectExistsValidator
|
|
from .custom_attributes.serializers import UserStoryCustomAttributeSerializer
|
|
from .custom_attributes.serializers import TaskCustomAttributeSerializer
|
|
from .custom_attributes.serializers import IssueCustomAttributeSerializer
|
|
from .notifications.mixins import WatchedResourceModelSerializer
|
|
from .votes.mixins.serializers import LikedResourceSerializerMixin
|
|
|
|
######################################################
|
|
## Custom values for selectors
|
|
######################################################
|
|
|
|
class PointsSerializer(serializers.ModelSerializer):
|
|
class Meta:
|
|
model = models.Points
|
|
i18n_fields = ("name",)
|
|
|
|
def validate_name(self, attrs, source):
|
|
"""
|
|
Check the points name is not duplicated in the project on creation
|
|
"""
|
|
qs = None
|
|
# If the user story status exists:
|
|
if self.object and attrs.get("name", None):
|
|
qs = models.Points.objects.filter(project=self.object.project, name=attrs[source])
|
|
|
|
if not self.object and attrs.get("project", None) and attrs.get("name", None):
|
|
qs = models.Points.objects.filter(project=attrs["project"], name=attrs[source])
|
|
|
|
if qs and qs.exists():
|
|
raise serializers.ValidationError(_("Name duplicated for the project"))
|
|
|
|
return attrs
|
|
|
|
|
|
class UserStoryStatusSerializer(serializers.ModelSerializer):
|
|
|
|
class Meta:
|
|
model = models.UserStoryStatus
|
|
i18n_fields = ("name",)
|
|
|
|
def validate_name(self, attrs, source):
|
|
"""
|
|
Check the status name is not duplicated in the project on creation
|
|
"""
|
|
qs = None
|
|
# If the user story status exists:
|
|
if self.object and attrs.get("name", None):
|
|
qs = models.UserStoryStatus.objects.filter(project=self.object.project,
|
|
name=attrs[source])
|
|
|
|
if not self.object and attrs.get("project", None) and attrs.get("name", None):
|
|
qs = models.UserStoryStatus.objects.filter(project=attrs["project"],
|
|
name=attrs[source])
|
|
|
|
if qs and qs.exists():
|
|
raise serializers.ValidationError(_("Name duplicated for the project"))
|
|
|
|
return attrs
|
|
|
|
|
|
class BasicUserStoryStatusSerializer(serializers.ModelSerializer):
|
|
|
|
class Meta:
|
|
model = models.UserStoryStatus
|
|
i18n_fields = ("name",)
|
|
fields = ("name", "color")
|
|
|
|
|
|
class TaskStatusSerializer(serializers.ModelSerializer):
|
|
class Meta:
|
|
model = models.TaskStatus
|
|
i18n_fields = ("name",)
|
|
|
|
def validate_name(self, attrs, source):
|
|
"""
|
|
Check the task name is not duplicated in the project on creation
|
|
"""
|
|
qs = None
|
|
# If the user story status exists:
|
|
if self.object and attrs.get("name", None):
|
|
qs = models.TaskStatus.objects.filter(project=self.object.project, name=attrs[source])
|
|
|
|
if not self.object and attrs.get("project", None) and attrs.get("name", None):
|
|
qs = models.TaskStatus.objects.filter(project=attrs["project"], name=attrs[source])
|
|
|
|
if qs and qs.exists():
|
|
raise serializers.ValidationError(_("Name duplicated for the project"))
|
|
|
|
return attrs
|
|
|
|
|
|
class BasicTaskStatusSerializerSerializer(serializers.ModelSerializer):
|
|
|
|
class Meta:
|
|
model = models.TaskStatus
|
|
i18n_fields = ("name",)
|
|
fields = ("name", "color")
|
|
|
|
|
|
class SeveritySerializer(serializers.ModelSerializer):
|
|
class Meta:
|
|
model = models.Severity
|
|
i18n_fields = ("name",)
|
|
|
|
|
|
class PrioritySerializer(serializers.ModelSerializer):
|
|
class Meta:
|
|
model = models.Priority
|
|
i18n_fields = ("name",)
|
|
|
|
|
|
class IssueStatusSerializer(serializers.ModelSerializer):
|
|
class Meta:
|
|
model = models.IssueStatus
|
|
i18n_fields = ("name",)
|
|
|
|
def validate_name(self, attrs, source):
|
|
"""
|
|
Check the issue name is not duplicated in the project on creation
|
|
"""
|
|
qs = None
|
|
# If the user story status exists:
|
|
if self.object and attrs.get("name", None):
|
|
qs = models.IssueStatus.objects.filter(project=self.object.project, name=attrs[source])
|
|
|
|
if not self.object and attrs.get("project", None) and attrs.get("name", None):
|
|
qs = models.IssueStatus.objects.filter(project=attrs["project"], name=attrs[source])
|
|
|
|
if qs and qs.exists():
|
|
raise serializers.ValidationError(_("Name duplicated for the project"))
|
|
|
|
return attrs
|
|
|
|
|
|
class BasicIssueStatusSerializer(serializers.ModelSerializer):
|
|
|
|
class Meta:
|
|
model = models.IssueStatus
|
|
i18n_fields = ("name",)
|
|
fields = ("name", "color")
|
|
|
|
|
|
class IssueTypeSerializer(serializers.ModelSerializer):
|
|
class Meta:
|
|
model = models.IssueType
|
|
i18n_fields = ("name",)
|
|
|
|
|
|
######################################################
|
|
## Members
|
|
######################################################
|
|
|
|
class MembershipSerializer(serializers.ModelSerializer):
|
|
role_name = serializers.CharField(source='role.name', required=False, read_only=True, i18n=True)
|
|
full_name = serializers.CharField(source='user.get_full_name', required=False, read_only=True)
|
|
user_email = serializers.EmailField(source='user.email', required=False, read_only=True)
|
|
is_user_active = serializers.BooleanField(source='user.is_active', required=False,
|
|
read_only=True)
|
|
email = serializers.EmailField(required=True)
|
|
color = serializers.CharField(source='user.color', required=False, read_only=True)
|
|
photo = serializers.SerializerMethodField("get_photo")
|
|
project_name = serializers.SerializerMethodField("get_project_name")
|
|
project_slug = serializers.SerializerMethodField("get_project_slug")
|
|
invited_by = UserBasicInfoSerializer(read_only=True)
|
|
|
|
class Meta:
|
|
model = models.Membership
|
|
# IMPORTANT: Maintain the MembershipAdminSerializer Meta up to date
|
|
# with this info (excluding here user_email and email)
|
|
read_only_fields = ("user",)
|
|
exclude = ("token", "user_email", "email")
|
|
|
|
def get_photo(self, project):
|
|
return get_photo_or_gravatar_url(project.user)
|
|
|
|
def get_project_name(self, obj):
|
|
return obj.project.name if obj and obj.project else ""
|
|
|
|
def get_project_slug(self, obj):
|
|
return obj.project.slug if obj and obj.project else ""
|
|
|
|
def validate_email(self, attrs, source):
|
|
project = attrs.get("project", None)
|
|
if project is None:
|
|
project = self.object.project
|
|
|
|
email = attrs[source]
|
|
|
|
qs = models.Membership.objects.all()
|
|
|
|
# If self.object is not None, the serializer is in update
|
|
# mode, and for it, it should exclude self.
|
|
if self.object:
|
|
qs = qs.exclude(pk=self.object.pk)
|
|
|
|
qs = qs.filter(Q(project_id=project.id, user__email=email) |
|
|
Q(project_id=project.id, email=email))
|
|
|
|
if qs.count() > 0:
|
|
raise serializers.ValidationError(_("Email address is already taken"))
|
|
|
|
return attrs
|
|
|
|
def validate_role(self, attrs, source):
|
|
project = attrs.get("project", None)
|
|
if project is None:
|
|
project = self.object.project
|
|
|
|
role = attrs[source]
|
|
|
|
if project.roles.filter(id=role.id).count() == 0:
|
|
raise serializers.ValidationError(_("Invalid role for the project"))
|
|
|
|
return attrs
|
|
|
|
def validate_is_owner(self, attrs, source):
|
|
is_owner = attrs[source]
|
|
project = attrs.get("project", None)
|
|
if project is None:
|
|
project = self.object.project
|
|
|
|
if (self.object and
|
|
not services.project_has_valid_owners(project, exclude_user=self.object.user)):
|
|
raise serializers.ValidationError(_("At least one of the user must be an active admin"))
|
|
|
|
return attrs
|
|
|
|
|
|
class MembershipAdminSerializer(MembershipSerializer):
|
|
class Meta:
|
|
model = models.Membership
|
|
# IMPORTANT: Maintain the MembershipSerializer Meta up to date
|
|
# with this info (excluding there user_email and email)
|
|
read_only_fields = ("user",)
|
|
exclude = ("token",)
|
|
|
|
|
|
class MemberBulkSerializer(RoleExistsValidator, serializers.Serializer):
|
|
email = serializers.EmailField()
|
|
role_id = serializers.IntegerField()
|
|
|
|
|
|
class MembersBulkSerializer(ProjectExistsValidator, serializers.Serializer):
|
|
project_id = serializers.IntegerField()
|
|
bulk_memberships = MemberBulkSerializer(many=True)
|
|
invitation_extra_text = serializers.CharField(required=False, max_length=255)
|
|
|
|
|
|
class ProjectMemberSerializer(serializers.ModelSerializer):
|
|
id = serializers.IntegerField(source="user.id", read_only=True)
|
|
username = serializers.CharField(source='user.username', read_only=True)
|
|
full_name = serializers.CharField(source='user.full_name', read_only=True)
|
|
full_name_display = serializers.CharField(source='user.get_full_name', read_only=True)
|
|
color = serializers.CharField(source='user.color', read_only=True)
|
|
photo = serializers.SerializerMethodField("get_photo")
|
|
is_active = serializers.BooleanField(source='user.is_active', read_only=True)
|
|
role_name = serializers.CharField(source='role.name', read_only=True, i18n=True)
|
|
|
|
class Meta:
|
|
model = models.Membership
|
|
exclude = ("project", "email", "created_at", "token", "invited_by", "invitation_extra_text", "user_order")
|
|
|
|
def get_photo(self, membership):
|
|
return get_photo_or_gravatar_url(membership.user)
|
|
|
|
|
|
######################################################
|
|
## Projects
|
|
######################################################
|
|
|
|
class ProjectSerializer(WatchersValidator, LikedResourceSerializerMixin, WatchedResourceModelSerializer, serializers.ModelSerializer):
|
|
tags = TagsField(default=[], required=False)
|
|
anon_permissions = PgArrayField(required=False)
|
|
public_permissions = PgArrayField(required=False)
|
|
my_permissions = serializers.SerializerMethodField("get_my_permissions")
|
|
i_am_owner = serializers.SerializerMethodField("get_i_am_owner")
|
|
tags_colors = TagsColorsField(required=False)
|
|
total_closed_milestones = serializers.SerializerMethodField("get_total_closed_milestones")
|
|
|
|
class Meta:
|
|
model = models.Project
|
|
read_only_fields = ("created_date", "modified_date", "owner", "slug")
|
|
exclude = ("last_us_ref", "last_task_ref", "last_issue_ref",
|
|
"issues_csv_uuid", "tasks_csv_uuid", "userstories_csv_uuid")
|
|
|
|
def get_my_permissions(self, obj):
|
|
if "request" in self.context:
|
|
return get_user_project_permissions(self.context["request"].user, obj)
|
|
return []
|
|
|
|
def get_i_am_owner(self, obj):
|
|
if "request" in self.context:
|
|
return is_project_owner(self.context["request"].user, obj)
|
|
return False
|
|
|
|
def get_total_closed_milestones(self, obj):
|
|
return obj.milestones.filter(closed=True).count()
|
|
|
|
def validate_total_milestones(self, attrs, source):
|
|
"""
|
|
Check that total_milestones is not null, it's an optional parameter but
|
|
not nullable in the model.
|
|
"""
|
|
value = attrs[source]
|
|
if value is None:
|
|
raise serializers.ValidationError(_("Total milestones must be major or equal to zero"))
|
|
return attrs
|
|
|
|
|
|
class ProjectDetailSerializer(ProjectSerializer):
|
|
us_statuses = UserStoryStatusSerializer(many=True, required=False) # User Stories
|
|
points = PointsSerializer(many=True, required=False)
|
|
|
|
task_statuses = TaskStatusSerializer(many=True, required=False) # Tasks
|
|
|
|
issue_statuses = IssueStatusSerializer(many=True, required=False)
|
|
issue_types = IssueTypeSerializer(many=True, required=False)
|
|
priorities = PrioritySerializer(many=True, required=False) # Issues
|
|
severities = SeveritySerializer(many=True, required=False)
|
|
|
|
userstory_custom_attributes = UserStoryCustomAttributeSerializer(source="userstorycustomattributes",
|
|
many=True, required=False)
|
|
task_custom_attributes = TaskCustomAttributeSerializer(source="taskcustomattributes",
|
|
many=True, required=False)
|
|
issue_custom_attributes = IssueCustomAttributeSerializer(source="issuecustomattributes",
|
|
many=True, required=False)
|
|
|
|
roles = ProjectRoleSerializer(source="roles", many=True, read_only=True)
|
|
members = serializers.SerializerMethodField(method_name="get_members")
|
|
|
|
def get_members(self, obj):
|
|
qs = obj.memberships.filter(user__isnull=False)
|
|
qs = qs.extra(select={"complete_user_name":"concat(full_name, username)"})
|
|
qs = qs.order_by("complete_user_name")
|
|
qs = qs.select_related("role", "user")
|
|
serializer = ProjectMemberSerializer(qs, many=True)
|
|
return serializer.data
|
|
|
|
|
|
class ProjectDetailAdminSerializer(ProjectDetailSerializer):
|
|
class Meta:
|
|
model = models.Project
|
|
read_only_fields = ("created_date", "modified_date", "owner", "slug")
|
|
exclude = ("last_us_ref", "last_task_ref", "last_issue_ref")
|
|
|
|
|
|
######################################################
|
|
## Liked
|
|
######################################################
|
|
|
|
class LikedSerializer(serializers.ModelSerializer):
|
|
class Meta:
|
|
model = models.Project
|
|
fields = ['id', 'name', 'slug']
|
|
|
|
|
|
|
|
######################################################
|
|
## Project Templates
|
|
######################################################
|
|
|
|
class ProjectTemplateSerializer(serializers.ModelSerializer):
|
|
default_options = JsonField(required=False, label=_("Default options"))
|
|
us_statuses = JsonField(required=False, label=_("User story's statuses"))
|
|
points = JsonField(required=False, label=_("Points"))
|
|
task_statuses = JsonField(required=False, label=_("Task's statuses"))
|
|
issue_statuses = JsonField(required=False, label=_("Issue's statuses"))
|
|
issue_types = JsonField(required=False, label=_("Issue's types"))
|
|
priorities = JsonField(required=False, label=_("Priorities"))
|
|
severities = JsonField(required=False, label=_("Severities"))
|
|
roles = JsonField(required=False, label=_("Roles"))
|
|
|
|
class Meta:
|
|
model = models.ProjectTemplate
|
|
read_only_fields = ("created_date", "modified_date")
|
|
i18n_fields = ("name", "description")
|
|
|
|
######################################################
|
|
## Project order bulk serializers
|
|
######################################################
|
|
|
|
class UpdateProjectOrderBulkSerializer(ProjectExistsValidator, serializers.Serializer):
|
|
project_id = serializers.IntegerField()
|
|
order = serializers.IntegerField()
|