blob: e3e6e5d58a434354ce2feb33fae33d83e68c9268 [file] [log] [blame]
# Copyright 2016 The Chromium Authors. All rights reserved.
# Use of this source code is govered by a BSD-style
# license that can be found in the LICENSE file or at
"""A servlet for project and component owners to view and edit field defs."""
import logging
import time
from third_party import ezt
from framework import framework_helpers
from framework import framework_views
from framework import permissions
from framework import servlet
from framework import urls
from proto import tracker_pb2
from tracker import field_helpers
from tracker import tracker_bizobj
from tracker import tracker_helpers
from tracker import tracker_views
class FieldDetail(servlet.Servlet):
"""Servlet allowing project owners to view and edit a custom field."""
_PAGE_TEMPLATE = 'tracker/field-detail-page.ezt'
def _GetFieldDef(self, mr):
"""Get the config and field definition to be viewed or edited."""
# TODO(jrobbins): since so many requests get the config object, and
# it is usually cached in RAM, just always get it and include it
# in the MonorailRequest, mr.
config =
mr.cnxn, mr.project_id)
field_def = tracker_bizobj.FindFieldDef(mr.field_name, config)
if not field_def:
self.abort(404, 'custom field not found')
return config, field_def
def AssertBasePermission(self, mr):
"""Check whether the user has any permission to visit this page.
mr: commonly used info parsed from the request.
super(FieldDetail, self).AssertBasePermission(mr)
_config, field_def = self._GetFieldDef(mr)
allow_view = permissions.CanViewFieldDef(
mr.auth.effective_ids, mr.perms, mr.project, field_def)
if not allow_view:
raise permissions.PermissionException(
'User is not allowed to view this field definition')
def GatherPageData(self, mr):
"""Build up a dictionary of data values to use when rendering the page.
mr: commonly used info parsed from the request.
Dict of values used by EZT for rendering the page.
config, field_def = self._GetFieldDef(mr)
user_views = framework_views.MakeAllUserViews(
mr.cnxn,, field_def.admin_ids)
field_def_view = tracker_views.FieldDefView(
field_def, config, user_views=user_views)
well_known_issue_types = tracker_helpers.FilterIssueTypes(config)
allow_edit = permissions.CanEditFieldDef(
mr.auth.effective_ids, mr.perms, mr.project, field_def)
# Right now we do not allow renaming of enum fields.
uneditable_name = field_def.field_type == tracker_pb2.FieldTypes.ENUM_TYPE
initial_admins = ', '.join(sorted([ for uv in field_def_view.admins]))
return {
'admin_tab_mode': servlet.Servlet.PROCESS_TAB_LABELS,
'field_def': field_def_view,
'allow_edit': ezt.boolean(allow_edit),
'uneditable_name': ezt.boolean(uneditable_name),
'initial_admins': initial_admins,
'initial_applicable_type': field_def.applicable_type,
'initial_applicable_predicate': field_def.applicable_predicate,
'well_known_issue_types': well_known_issue_types,
def ProcessFormData(self, mr, post_data):
"""Validate and store the contents of the issues tracker admin page.
mr: commonly used info parsed from the request.
post_data: HTML form data from the request.
String URL to redirect the user to, or None if response was already sent.
config, field_def = self._GetFieldDef(mr)
allow_edit = permissions.CanEditFieldDef(
mr.auth.effective_ids, mr.perms, mr.project, field_def)
if not allow_edit:
raise permissions.PermissionException(
'User is not allowed to delete this field')
if 'deletefield' in post_data:
self._ProcessDeleteField(mr, field_def)
return framework_helpers.FormatAbsoluteURL(
mr, urls.ADMIN_LABELS, deleted=1, ts=int(time.time()))
self._ProcessEditField(mr, post_data, config, field_def)
return framework_helpers.FormatAbsoluteURL(
mr, urls.FIELD_DETAIL, field=field_def.field_name,
saved=1, ts=int(time.time()))
def _ProcessDeleteField(self, mr, field_def):
"""The user wants to delete the specified custom field definition."""
mr.cnxn, mr.project_id, field_def.field_id)
# TODO(jrobbins): add logic to reaper cron task to look for
# soft deleted field definitions that have no issues with
# any value and hard deleted them.
def _ProcessEditField(self, mr, post_data, config, field_def):
"""The user wants to edit this field definition."""
# TODO(jrobbins): future feature: editable field names
parsed = field_helpers.ParseFieldDefRequest(post_data, config)
admin_ids, _admin_str = tracker_helpers.ParseAdminUsers(
mr.cnxn, post_data['admin_names'],
# TODO(jrobbins): bounce on validation errors
mr.cnxn, mr.project_id, field_def.field_id,
min_value=parsed.min_value, max_value=parsed.max_value,
regex=parsed.regex, needs_member=parsed.needs_member,
needs_perm=parsed.needs_perm, grants_perm=parsed.grants_perm,
notify_on=parsed.notify_on, is_multivalued=parsed.is_multivalued,
docstring=parsed.field_docstring, admin_ids=admin_ids)
mr.cnxn, mr.project, well_known_labels=parsed.revised_labels)