blob: f9c0435c09658810c07c6567e72aaa7b574936f3 [file] [log] [blame]
# Copyright 2016 The Chromium Authors. All rights reserved.
# Use of this source code is governed by a BSD-style
# license that can be found in the LICENSE file or at
"""Servlets for hotlist details main subtab."""
from __future__ import print_function
from __future__ import division
from __future__ import absolute_import
import time
import ezt
from features import hotlist_helpers
from framework import framework_bizobj
from framework import flaskservlet
from framework import framework_helpers
from framework import servlet
from framework import permissions
from framework import urls
_MSG_DESCRIPTION_MISSING = 'Description is missing.'
_MSG_SUMMARY_MISSING = 'Summary is missing.'
_MSG_NAME_MISSING = 'Hotlist name is missing.'
_MSG_COL_SPEC_MISSING = 'Hotlist default columns are missing.'
_MSG_HOTLIST_NAME_NOT_AVAIL = 'You already have a hotlist with that name.'
# pylint: disable=line-too-long
_MSG_INVALID_HOTLIST_NAME = "Invalid hotlist name. Please make sure your hotlist name begins with a letter followed by any number of letters, numbers, -'s, and .'s"
class HotlistDetails(servlet.Servlet):
"""A page with hotlist details and editing options."""
_PAGE_TEMPLATE = 'features/hotlist-details-page.ezt'
_MAIN_TAB_MODE = flaskservlet.FlaskServlet.HOTLIST_TAB_DETAILS
def AssertBasePermission(self, mr):
super(HotlistDetails, self).AssertBasePermission(mr)
if not permissions.CanViewHotlist(
mr.auth.effective_ids, mr.perms, mr.hotlist):
raise permissions.PermissionException(
'User is not allowed to view the hotlist details')
def GatherPageData(self, mr):
"""Buil up a dictionary of data values to use when rendering the page."""
if mr.auth.user_id:
mr.cnxn, mr.auth.user_id, mr.hotlist_id)
cant_administer_hotlist = not permissions.CanAdministerHotlist(
mr.auth.effective_ids, mr.perms, mr.hotlist)
return {
'initial_summary': mr.hotlist.summary,
'initial_description': mr.hotlist.description,
'initial_default_col_spec': mr.hotlist.default_col_spec,
'initial_is_private': ezt.boolean(mr.hotlist.is_private),
'cant_administer_hotlist': ezt.boolean(cant_administer_hotlist),
'viewing_user_page': ezt.boolean(True),
'new_ui_url': '%s/%s/settings' % (urls.HOTLISTS, mr.hotlist_id),
def ProcessFormData(self, mr, post_data):
"""Process the posted form."""
if not permissions.CanAdministerHotlist(
mr.auth.effective_ids, mr.perms, mr.hotlist):
raise permissions.PermissionException(
'User is not allowed to update hotlist settings.')
if post_data.get('deletestate') == 'true':
hotlist_helpers.RemoveHotlist(mr.cnxn, mr.hotlist_id,
return framework_helpers.FormatAbsoluteURL(
mr, '/u/%s/hotlists' %,
saved=1, ts=int(time.time()), include_project=False)
(summary, description, name, default_col_spec) = self._ParseMetaData(
post_data, mr)
is_private = post_data.get('is_private') != 'no'
if not mr.errors.AnyErrors():
mr.cnxn, mr.hotlist.hotlist_id, name=name, summary=summary,
description=description, is_private=is_private,
if mr.errors.AnyErrors():
mr, initial_summary=summary, initial_description=description,
initial_name=name, initial_default_col_spec=default_col_spec)
return framework_helpers.FormatAbsoluteURL(
mr, '/u/%s/hotlists/%s%s' % (
mr.auth.user_id, mr.hotlist_id, urls.HOTLIST_DETAIL),
saved=1, ts=int(time.time()),
def _ParseMetaData(self, post_data, mr):
"""Process a POST on the hotlist metadata."""
summary = None
description = ''
name = None
default_col_spec = None
if 'summary' in post_data:
summary = post_data['summary']
if not summary:
mr.errors.summary = _MSG_SUMMARY_MISSING
if 'description' in post_data:
description = post_data['description']
if 'name' in post_data:
name = post_data['name']
if not name: = _MSG_NAME_MISSING
if not framework_bizobj.IsValidHotlistName(name): = _MSG_INVALID_HOTLIST_NAME
mr.cnxn, [name], [mr.auth.user_id]) and ( != name.lower()): = _MSG_HOTLIST_NAME_NOT_AVAIL
if 'default_col_spec' in post_data:
default_col_spec = post_data['default_col_spec']
return summary, description, name, default_col_spec
# def GetHotlistDetailsPage(self, **kwargs):
# return self.handler(**kwargs)
# def PostHotlistDetailsPage(self, **kwargs):
# return self.handler(**kwargs)