OLD | NEW |
(Empty) | |
| 1 # Copyright 2016 The Chromium Authors. All rights reserved. |
| 2 # Use of this source code is govered by a BSD-style |
| 3 # license that can be found in the LICENSE file or at |
| 4 # https://developers.google.com/open-source/licenses/bsd |
| 5 |
| 6 """A servlet for project and component owners to view and edit field defs.""" |
| 7 |
| 8 import logging |
| 9 import time |
| 10 |
| 11 from third_party import ezt |
| 12 |
| 13 from framework import framework_helpers |
| 14 from framework import framework_views |
| 15 from framework import permissions |
| 16 from framework import servlet |
| 17 from framework import urls |
| 18 from proto import tracker_pb2 |
| 19 from tracker import field_helpers |
| 20 from tracker import tracker_bizobj |
| 21 from tracker import tracker_helpers |
| 22 from tracker import tracker_views |
| 23 |
| 24 |
| 25 class FieldDetail(servlet.Servlet): |
| 26 """Servlet allowing project owners to view and edit a custom field.""" |
| 27 |
| 28 _MAIN_TAB_MODE = servlet.Servlet.MAIN_TAB_PROCESS |
| 29 _PAGE_TEMPLATE = 'tracker/field-detail-page.ezt' |
| 30 |
| 31 def _GetFieldDef(self, mr): |
| 32 """Get the config and field definition to be viewed or edited.""" |
| 33 # TODO(jrobbins): since so many requests get the config object, and |
| 34 # it is usually cached in RAM, just always get it and include it |
| 35 # in the MonorailRequest, mr. |
| 36 config = self.services.config.GetProjectConfig( |
| 37 mr.cnxn, mr.project_id) |
| 38 field_def = tracker_bizobj.FindFieldDef(mr.field_name, config) |
| 39 if not field_def: |
| 40 self.abort(404, 'custom field not found') |
| 41 return config, field_def |
| 42 |
| 43 def AssertBasePermission(self, mr): |
| 44 """Check whether the user has any permission to visit this page. |
| 45 |
| 46 Args: |
| 47 mr: commonly used info parsed from the request. |
| 48 """ |
| 49 super(FieldDetail, self).AssertBasePermission(mr) |
| 50 _config, field_def = self._GetFieldDef(mr) |
| 51 |
| 52 allow_view = permissions.CanViewFieldDef( |
| 53 mr.auth.effective_ids, mr.perms, mr.project, field_def) |
| 54 if not allow_view: |
| 55 raise permissions.PermissionException( |
| 56 'User is not allowed to view this field definition') |
| 57 |
| 58 def GatherPageData(self, mr): |
| 59 """Build up a dictionary of data values to use when rendering the page. |
| 60 |
| 61 Args: |
| 62 mr: commonly used info parsed from the request. |
| 63 |
| 64 Returns: |
| 65 Dict of values used by EZT for rendering the page. |
| 66 """ |
| 67 config, field_def = self._GetFieldDef(mr) |
| 68 user_views = framework_views.MakeAllUserViews( |
| 69 mr.cnxn, self.services.user, field_def.admin_ids) |
| 70 field_def_view = tracker_views.FieldDefView( |
| 71 field_def, config, user_views=user_views) |
| 72 |
| 73 well_known_issue_types = tracker_helpers.FilterIssueTypes(config) |
| 74 |
| 75 allow_edit = permissions.CanEditFieldDef( |
| 76 mr.auth.effective_ids, mr.perms, mr.project, field_def) |
| 77 |
| 78 # Right now we do not allow renaming of enum fields. |
| 79 uneditable_name = field_def.field_type == tracker_pb2.FieldTypes.ENUM_TYPE |
| 80 |
| 81 initial_admins = ', '.join(sorted([ |
| 82 uv.email for uv in field_def_view.admins])) |
| 83 |
| 84 return { |
| 85 'admin_tab_mode': servlet.Servlet.PROCESS_TAB_LABELS, |
| 86 'field_def': field_def_view, |
| 87 'allow_edit': ezt.boolean(allow_edit), |
| 88 'uneditable_name': ezt.boolean(uneditable_name), |
| 89 'initial_admins': initial_admins, |
| 90 'initial_applicable_type': field_def.applicable_type, |
| 91 'initial_applicable_predicate': field_def.applicable_predicate, |
| 92 'well_known_issue_types': well_known_issue_types, |
| 93 } |
| 94 |
| 95 def ProcessFormData(self, mr, post_data): |
| 96 """Validate and store the contents of the issues tracker admin page. |
| 97 |
| 98 Args: |
| 99 mr: commonly used info parsed from the request. |
| 100 post_data: HTML form data from the request. |
| 101 |
| 102 Returns: |
| 103 String URL to redirect the user to, or None if response was already sent. |
| 104 """ |
| 105 config, field_def = self._GetFieldDef(mr) |
| 106 allow_edit = permissions.CanEditFieldDef( |
| 107 mr.auth.effective_ids, mr.perms, mr.project, field_def) |
| 108 if not allow_edit: |
| 109 raise permissions.PermissionException( |
| 110 'User is not allowed to delete this field') |
| 111 |
| 112 if 'deletefield' in post_data: |
| 113 self._ProcessDeleteField(mr, field_def) |
| 114 return framework_helpers.FormatAbsoluteURL( |
| 115 mr, urls.ADMIN_LABELS, deleted=1, ts=int(time.time())) |
| 116 |
| 117 else: |
| 118 self._ProcessEditField(mr, post_data, config, field_def) |
| 119 return framework_helpers.FormatAbsoluteURL( |
| 120 mr, urls.FIELD_DETAIL, field=field_def.field_name, |
| 121 saved=1, ts=int(time.time())) |
| 122 |
| 123 def _ProcessDeleteField(self, mr, field_def): |
| 124 """The user wants to delete the specified custom field definition.""" |
| 125 self.services.config.SoftDeleteFieldDef( |
| 126 mr.cnxn, mr.project_id, field_def.field_id) |
| 127 |
| 128 # TODO(jrobbins): add logic to reaper cron task to look for |
| 129 # soft deleted field definitions that have no issues with |
| 130 # any value and hard deleted them. |
| 131 |
| 132 def _ProcessEditField(self, mr, post_data, config, field_def): |
| 133 """The user wants to edit this field definition.""" |
| 134 # TODO(jrobbins): future feature: editable field names |
| 135 |
| 136 parsed = field_helpers.ParseFieldDefRequest(post_data, config) |
| 137 |
| 138 admin_ids, _admin_str = tracker_helpers.ParseAdminUsers( |
| 139 mr.cnxn, post_data['admin_names'], self.services.user) |
| 140 |
| 141 # TODO(jrobbins): bounce on validation errors |
| 142 |
| 143 self.services.config.UpdateFieldDef( |
| 144 mr.cnxn, mr.project_id, field_def.field_id, |
| 145 applicable_type=parsed.applicable_type, |
| 146 applicable_predicate=parsed.applicable_predicate, |
| 147 is_required=parsed.is_required, |
| 148 min_value=parsed.min_value, max_value=parsed.max_value, |
| 149 regex=parsed.regex, needs_member=parsed.needs_member, |
| 150 needs_perm=parsed.needs_perm, grants_perm=parsed.grants_perm, |
| 151 notify_on=parsed.notify_on, is_multivalued=parsed.is_multivalued, |
| 152 docstring=parsed.field_docstring, admin_ids=admin_ids) |
| 153 self.services.config.UpdateConfig( |
| 154 mr.cnxn, mr.project, well_known_labels=parsed.revised_labels) |
OLD | NEW |