taiga-back/taiga/projects/epics/services.py

424 lines
16 KiB
Python

# -*- coding: utf-8 -*-
# Copyright (C) 2014-2016 Andrey Antukh <niwi@niwi.nz>
# Copyright (C) 2014-2016 Jesús Espino <jespinog@gmail.com>
# Copyright (C) 2014-2016 David Barragán <bameda@dbarragan.com>
# Copyright (C) 2014-2016 Alejandro Alonso <alejandro.alonso@kaleidos.net>
# 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/>.
import csv
import io
from collections import OrderedDict
from operator import itemgetter
from contextlib import closing
from django.db import connection
from django.utils.translation import ugettext as _
from taiga.base.utils import db, text
from taiga.projects.epics.apps import connect_epics_signals
from taiga.projects.epics.apps import disconnect_epics_signals
from taiga.projects.services import apply_order_updates
from taiga.projects.userstories.apps import connect_userstories_signals
from taiga.projects.userstories.apps import disconnect_userstories_signals
from taiga.projects.userstories.services import get_userstories_from_bulk
from taiga.events import events
from taiga.projects.votes.utils import attach_total_voters_to_queryset
from taiga.projects.notifications.utils import attach_watchers_to_queryset
from . import models
#####################################################
# Bulk actions
#####################################################
def get_epics_from_bulk(bulk_data, **additional_fields):
"""Convert `bulk_data` into a list of epics.
:param bulk_data: List of epics in bulk format.
:param additional_fields: Additional fields when instantiating each epic.
:return: List of `Epic` instances.
"""
return [models.Epic(subject=line, **additional_fields)
for line in text.split_in_lines(bulk_data)]
def create_epics_in_bulk(bulk_data, callback=None, precall=None, **additional_fields):
"""Create epics from `bulk_data`.
:param bulk_data: List of epics in bulk format.
:param callback: Callback to execute after each epic save.
:param additional_fields: Additional fields when instantiating each epic.
:return: List of created `Epic` instances.
"""
epics = get_epics_from_bulk(bulk_data, **additional_fields)
disconnect_epics_signals()
try:
db.save_in_bulk(epics, callback, precall)
finally:
connect_epics_signals()
return epics
def update_epics_order_in_bulk(bulk_data: list, field: str, project: object):
"""
Update the order of some epics.
`bulk_data` should be a list of tuples with the following format:
[{'epic_id': <value>, 'order': <value>}, ...]
"""
epics = project.epics.all()
epic_orders = {e.id: getattr(e, field) for e in epics}
new_epic_orders = {d["epic_id"]: d["order"] for d in bulk_data}
apply_order_updates(epic_orders, new_epic_orders)
epic_ids = epic_orders.keys()
events.emit_event_for_ids(ids=epic_ids,
content_type="epics.epic",
projectid=project.pk)
db.update_attr_in_bulk_for_ids(epic_orders, field, models.Epic)
return epic_orders
def create_related_userstories_in_bulk(bulk_data, epic, **additional_fields):
"""Create user stories from `bulk_data`.
:param epic: Element where all the user stories will be contained
:param bulk_data: List of user stories in bulk format.
:param additional_fields: Additional fields when instantiating each user story.
:return: List of created `Task` instances.
"""
userstories = get_userstories_from_bulk(bulk_data, **additional_fields)
disconnect_userstories_signals()
try:
db.save_in_bulk(userstories)
related_userstories = []
for userstory in userstories:
related_userstories.append(
models.RelatedUserStory(
user_story=userstory,
epic=epic
)
)
db.save_in_bulk(related_userstories)
finally:
connect_userstories_signals()
return userstories
def update_epic_related_userstories_order_in_bulk(bulk_data: list, epic: object):
"""
Updates the order of the related userstories of an specific epic.
`bulk_data` should be a list of dicts with the following format:
`epic` is the epic with related stories.
[{'us_id': <value>, 'order': <value>}, ...]
"""
related_user_stories = epic.relateduserstory_set.all()
# select_related
rus_orders = {rus.id: rus.order for rus in related_user_stories}
rus_conversion = {rus.user_story_id: rus.id for rus in related_user_stories}
new_rus_orders = {rus_conversion[e["us_id"]]: e["order"] for e in bulk_data
if e["us_id"] in rus_conversion}
apply_order_updates(rus_orders, new_rus_orders)
if rus_orders:
related_user_story_ids = rus_orders.keys()
events.emit_event_for_ids(ids=related_user_story_ids,
content_type="epics.relateduserstory",
projectid=epic.project_id)
db.update_attr_in_bulk_for_ids(rus_orders, "order", models.RelatedUserStory)
return rus_orders
#####################################################
# CSV
#####################################################
def epics_to_csv(project, queryset):
csv_data = io.StringIO()
fieldnames = ["ref", "subject", "description", "owner", "owner_full_name", "assigned_to",
"assigned_to_full_name", "status", "epics_order", "client_requirement",
"team_requirement", "attachments", "tags", "watchers", "voters",
"created_date", "modified_date"]
custom_attrs = project.epiccustomattributes.all()
for custom_attr in custom_attrs:
fieldnames.append(custom_attr.name)
queryset = queryset.prefetch_related("attachments",
"custom_attributes_values")
queryset = queryset.select_related("owner",
"assigned_to",
"status",
"project")
queryset = attach_total_voters_to_queryset(queryset)
queryset = attach_watchers_to_queryset(queryset)
writer = csv.DictWriter(csv_data, fieldnames=fieldnames)
writer.writeheader()
for epic in queryset:
epic_data = {
"ref": epic.ref,
"subject": epic.subject,
"description": epic.description,
"owner": epic.owner.username if epic.owner else None,
"owner_full_name": epic.owner.get_full_name() if epic.owner else None,
"assigned_to": epic.assigned_to.username if epic.assigned_to else None,
"assigned_to_full_name": epic.assigned_to.get_full_name() if epic.assigned_to else None,
"status": epic.status.name if epic.status else None,
"epics_order": epic.epics_order,
"client_requirement": epic.client_requirement,
"team_requirement": epic.team_requirement,
"attachments": epic.attachments.count(),
"tags": ",".join(epic.tags or []),
"watchers": epic.watchers,
"voters": epic.total_voters,
"created_date": epic.created_date,
"modified_date": epic.modified_date,
}
for custom_attr in custom_attrs:
value = epic.custom_attributes_values.attributes_values.get(str(custom_attr.id), None)
epic_data[custom_attr.name] = value
writer.writerow(epic_data)
return csv_data
#####################################################
# Api filter data
#####################################################
def _get_epics_statuses(project, queryset):
compiler = connection.ops.compiler(queryset.query.compiler)(queryset.query, connection, None)
queryset_where_tuple = queryset.query.where.as_sql(compiler, connection)
where = queryset_where_tuple[0]
where_params = queryset_where_tuple[1]
extra_sql = """
SELECT "projects_epicstatus"."id",
"projects_epicstatus"."name",
"projects_epicstatus"."color",
"projects_epicstatus"."order",
(SELECT count(*)
FROM "epics_epic"
INNER JOIN "projects_project" ON
("epics_epic"."project_id" = "projects_project"."id")
WHERE {where} AND "epics_epic"."status_id" = "projects_epicstatus"."id")
FROM "projects_epicstatus"
WHERE "projects_epicstatus"."project_id" = %s
ORDER BY "projects_epicstatus"."order";
""".format(where=where)
with closing(connection.cursor()) as cursor:
cursor.execute(extra_sql, where_params + [project.id])
rows = cursor.fetchall()
result = []
for id, name, color, order, count in rows:
result.append({
"id": id,
"name": _(name),
"color": color,
"order": order,
"count": count,
})
return sorted(result, key=itemgetter("order"))
def _get_epics_assigned_to(project, queryset):
compiler = connection.ops.compiler(queryset.query.compiler)(queryset.query, connection, None)
queryset_where_tuple = queryset.query.where.as_sql(compiler, connection)
where = queryset_where_tuple[0]
where_params = queryset_where_tuple[1]
extra_sql = """
WITH counters AS (
SELECT assigned_to_id, count(assigned_to_id) count
FROM "epics_epic"
INNER JOIN "projects_project" ON ("epics_epic"."project_id" = "projects_project"."id")
WHERE {where} AND "epics_epic"."assigned_to_id" IS NOT NULL
GROUP BY assigned_to_id
)
SELECT "projects_membership"."user_id" user_id,
"users_user"."full_name",
"users_user"."username",
COALESCE("counters".count, 0) count
FROM projects_membership
LEFT OUTER JOIN counters ON ("projects_membership"."user_id" = "counters"."assigned_to_id")
INNER JOIN "users_user" ON ("projects_membership"."user_id" = "users_user"."id")
WHERE "projects_membership"."project_id" = %s
AND "projects_membership"."user_id" IS NOT NULL
-- unassigned epics
UNION
SELECT NULL user_id, NULL, NULL, count(coalesce(assigned_to_id, -1)) count
FROM "epics_epic"
INNER JOIN "projects_project" ON ("epics_epic"."project_id" = "projects_project"."id")
WHERE {where} AND "epics_epic"."assigned_to_id" IS NULL
GROUP BY assigned_to_id
""".format(where=where)
with closing(connection.cursor()) as cursor:
cursor.execute(extra_sql, where_params + [project.id] + where_params)
rows = cursor.fetchall()
result = []
none_valued_added = False
for id, full_name, username, count in rows:
result.append({
"id": id,
"full_name": full_name or username or "",
"count": count,
})
if id is None:
none_valued_added = True
# If there was no epic with null assigned_to we manually add it
if not none_valued_added:
result.append({
"id": None,
"full_name": "",
"count": 0,
})
return sorted(result, key=itemgetter("full_name"))
def _get_epics_owners(project, queryset):
compiler = connection.ops.compiler(queryset.query.compiler)(queryset.query, connection, None)
queryset_where_tuple = queryset.query.where.as_sql(compiler, connection)
where = queryset_where_tuple[0]
where_params = queryset_where_tuple[1]
extra_sql = """
WITH counters AS (
SELECT "epics_epic"."owner_id" owner_id,
count(coalesce("epics_epic"."owner_id", -1)) count
FROM "epics_epic"
INNER JOIN "projects_project" ON ("epics_epic"."project_id" = "projects_project"."id")
WHERE {where}
GROUP BY "epics_epic"."owner_id"
)
SELECT "projects_membership"."user_id" id,
"users_user"."full_name",
"users_user"."username",
COALESCE("counters".count, 0) count
FROM projects_membership
LEFT OUTER JOIN counters ON ("projects_membership"."user_id" = "counters"."owner_id")
INNER JOIN "users_user" ON ("projects_membership"."user_id" = "users_user"."id")
WHERE "projects_membership"."project_id" = %s
AND "projects_membership"."user_id" IS NOT NULL
-- System users
UNION
SELECT "users_user"."id" user_id,
"users_user"."full_name" full_name,
"users_user"."username" username,
COALESCE("counters".count, 0) count
FROM users_user
LEFT OUTER JOIN counters ON ("users_user"."id" = "counters"."owner_id")
WHERE ("users_user"."is_system" IS TRUE)
""".format(where=where)
with closing(connection.cursor()) as cursor:
cursor.execute(extra_sql, where_params + [project.id])
rows = cursor.fetchall()
result = []
for id, full_name, username, count in rows:
if count > 0:
result.append({
"id": id,
"full_name": full_name or username or "",
"count": count,
})
return sorted(result, key=itemgetter("full_name"))
def _get_epics_tags(project, queryset):
compiler = connection.ops.compiler(queryset.query.compiler)(queryset.query, connection, None)
queryset_where_tuple = queryset.query.where.as_sql(compiler, connection)
where = queryset_where_tuple[0]
where_params = queryset_where_tuple[1]
extra_sql = """
WITH epics_tags AS (
SELECT tag,
COUNT(tag) counter FROM (
SELECT UNNEST(epics_epic.tags) tag
FROM epics_epic
INNER JOIN projects_project
ON (epics_epic.project_id = projects_project.id)
WHERE {where}) tags
GROUP BY tag),
project_tags AS (
SELECT reduce_dim(tags_colors) tag_color
FROM projects_project
WHERE id=%s)
SELECT tag_color[1] tag, COALESCE(epics_tags.counter, 0) counter
FROM project_tags
LEFT JOIN epics_tags ON project_tags.tag_color[1] = epics_tags.tag
ORDER BY tag
""".format(where=where)
with closing(connection.cursor()) as cursor:
cursor.execute(extra_sql, where_params + [project.id])
rows = cursor.fetchall()
result = []
for name, count in rows:
result.append({
"name": name,
"count": count,
})
return sorted(result, key=itemgetter("name"))
def get_epics_filters_data(project, querysets):
"""
Given a project and an epics queryset, return a simple data structure
of all possible filters for the epics in the queryset.
"""
data = OrderedDict([
("statuses", _get_epics_statuses(project, querysets["statuses"])),
("assigned_to", _get_epics_assigned_to(project, querysets["assigned_to"])),
("owners", _get_epics_owners(project, querysets["owners"])),
("tags", _get_epics_tags(project, querysets["tags"])),
])
return data