def _confirm(html_title, message):
if not html.request.has_var("_do_confirm") and not html.request.has_var(
"_do_actions"):
# TODO: get the breadcrumb from all call sites
wato_html_head(title=html_title, breadcrumb=Breadcrumb())
confirm_options = [(_("Confirm"), "_do_confirm")]
return confirm_with_preview(message, confirm_options)
def _rename_tags_after_confirmation(operation):
# type: (ABCOperation) -> Union[bool, str]
"""Handle renaming and deletion of tags
Find affected hosts, folders and rules. Remove or fix those rules according
the users' wishes.
"""
repair_mode = html.request.var("_repair")
if repair_mode is not None:
try:
mode = TagCleanupMode(repair_mode)
except ValueError:
raise MKUserError("_repair", "Invalid mode")
if mode == TagCleanupMode.ABORT:
raise MKUserError("id_0", _("Aborting change."))
# make attribute unknown to system, important for save() operations
if isinstance(operation, OperationRemoveTagGroup):
watolib.host_attributes.undeclare_host_tag_attribute(
operation.tag_group_id)
affected_folders, affected_hosts, affected_rulesets = \
_change_host_tags_in_folders(operation, mode, watolib.Folder.root_folder())
return _("Modified folders: %d, modified hosts: %d, modified rulesets: %d") % \
(len(affected_folders), len(affected_hosts), len(affected_rulesets))
message = u""
affected_folders, affected_hosts, affected_rulesets = \
_change_host_tags_in_folders(operation, TagCleanupMode.CHECK, watolib.Folder.root_folder())
if affected_folders:
message += _("Affected folders with an explicit reference to this tag "
"group and that are affected by the change") + ":"
with html.plugged():
_show_affected_folders(affected_folders)
message += html.drain()
if affected_hosts:
message += _("Hosts where this tag group is explicitely set "
"and that are effected by the change") + ":"
with html.plugged():
_show_affected_hosts(affected_hosts)
message += html.drain()
if affected_rulesets:
message += _(
"Rulesets that contain rules with references to the changed tags"
) + ":"
with html.plugged():
_show_affected_rulesets(affected_rulesets)
message += html.drain()
if message:
wato_html_head(operation.confirm_title())
html.open_div(class_="really")
html.h3(_("Your modifications affect some objects"))
html.write_text(message)
html.br()
html.write_text(
_("WATO can repair things for you. It can rename tags in folders, host and rules. "
"Removed tag groups will be removed from hosts and folders, removed tags will be "
"replaced with the default value for the tag group (for hosts and folders). What "
"rules concern, you have to decide how to proceed."))
html.begin_form("confirm", method="POST")
if affected_rulesets and _is_removing_tags(operation):
html.br()
html.b(
_("Some tags that are used in rules have been removed by you. What "
"shall we do with that rules?"))
html.open_ul()
html.radiobutton(
"_repair", "remove", True,
_("Just remove the affected tags from the rules."))
html.br()
html.radiobutton(
"_repair", "delete", False,
_("Delete rules containing tags that have been removed, if tag is used in a positive sense. Just remove that tag if it's used negated."
))
else:
html.open_ul()
html.radiobutton("_repair", "repair", True,
_("Fix affected folders, hosts and rules."))
html.br()
html.radiobutton("_repair", "abort", False,
_("Abort your modifications."))
html.close_ul()
html.button("_do_confirm", _("Proceed"), "")
html.hidden_fields(add_action_vars=True)
html.end_form()
html.close_div()
return False
return True
def _wato_page_handler(current_mode: str,
mode_permissions: Optional[List[PermissionName]],
mode_class: Type[WatoMode]) -> None:
try:
init_wato_datastructures(with_wato_lock=not html.is_transaction())
except Exception:
# Snapshot must work in any case
if current_mode == 'snapshot':
pass
else:
raise
# Check general permission for this mode
if mode_permissions is not None and not config.user.may("wato.seeall"):
_ensure_mode_permissions(mode_permissions)
mode = mode_class()
# Do actions (might switch mode)
if html.is_transaction():
try:
config.user.need_permission("wato.edit")
# Even if the user has seen this mode because auf "seeall",
# he needs an explicit access permission for doing changes:
if config.user.may("wato.seeall"):
if mode_permissions:
_ensure_mode_permissions(mode_permissions)
if cmk.gui.watolib.read_only.is_enabled(
) and not cmk.gui.watolib.read_only.may_override():
raise MKUserError(None, cmk.gui.watolib.read_only.message())
result = mode.action()
if isinstance(result, (tuple, str, bool)):
raise MKGeneralException(
f"WatoMode \"{current_mode}\" returns unsupported return value: {result!r}"
)
# We assume something has been modified and increase the config generation ID by one.
update_config_generation()
if config.wato_use_git:
do_git_commit()
# Handle two cases:
# a) Don't render the page content after action
# (a confirm dialog is displayed by the action, or a non-HTML content was sent)
# b) Redirect to another page
if isinstance(result, FinalizeRequest):
raise result
except MKUserError as e:
html.add_user_error(e.varname, str(e))
except MKAuthException as e:
reason = e.args[0]
html.add_user_error(None, reason)
breadcrumb = make_main_menu_breadcrumb(
mode.main_menu()) + mode.breadcrumb()
page_menu = mode.page_menu(breadcrumb)
wato_html_head(title=mode.title(),
breadcrumb=breadcrumb,
page_menu=page_menu,
show_body_start=display_options.enabled(display_options.H),
show_top_heading=display_options.enabled(display_options.T))
if not html.is_transaction() or (cmk.gui.watolib.read_only.is_enabled() and
cmk.gui.watolib.read_only.may_override()):
_show_read_only_warning()
# Show outcome of failed action on this page
if html.has_user_errors():
html.show_user_errors()
# Show outcome of previous page (that redirected to this one)
for message in get_flashed_messages():
html.show_message(message)
# Show content
mode.handle_page()
if is_sidebar_reload_needed():
html.reload_whole_page()
wato_html_footer(show_body_end=display_options.enabled(display_options.H))
def _rename_tags_after_confirmation(tag_id, operations):
"""Handle renaming and deletion of tags
Find affected hosts, folders and rules. Remove or fix those rules according
the the users' wishes. In case auf auxiliary tags the tag_id is None. In
other cases it is the id of the tag group currently being edited.
"""
mode = html.request.var("_repair")
if mode == "abort":
raise MKUserError("id_0", _("Aborting change."))
elif mode:
# make attribute unknown to system, important for save() operations
if tag_id and isinstance(operations, list):
watolib.host_attributes.undeclare_host_tag_attribute(tag_id)
affected_folders, affected_hosts, affected_rulesets = \
_change_host_tags_in_folders(tag_id, operations, mode, watolib.Folder.root_folder())
return _("Modified folders: %d, modified hosts: %d, modified rulesets: %d") % \
(len(affected_folders), len(affected_hosts), len(affected_rulesets))
message = ""
affected_folders, affected_hosts, affected_rulesets = \
_change_host_tags_in_folders(tag_id, operations, "check", watolib.Folder.root_folder())
if affected_folders:
message += _("Affected folders with an explicit reference to this tag "
"group and that are affected by the change") + ":<ul>"
for folder in affected_folders:
message += '<li><a href="%s">%s</a></li>' % (folder.edit_url(), folder.alias_path())
message += "</ul>"
if affected_hosts:
message += _("Hosts where this tag group is explicitely set "
"and that are effected by the change") + ":<ul><li>"
for nr, host in enumerate(affected_hosts):
if nr > 20:
message += "... (%d more)" % (len(affected_hosts) - 20)
break
elif nr > 0:
message += ", "
message += '<a href="%s">%s</a>' % (host.edit_url(), host.name())
message += "</li></ul>"
if affected_rulesets:
message += _("Rulesets that contain rules with references to the changed tags") + ":<ul>"
for ruleset in affected_rulesets:
message += '<li><a href="%s">%s</a></li>' % (watolib.folder_preserving_link(
[("mode", "edit_ruleset"), ("varname", ruleset.name)]), ruleset.title())
message += "</ul>"
if not message and isinstance(operations, tuple): # deletion of unused tag group
html.open_div(class_="really")
html.begin_form("confirm")
html.write_text(_("Please confirm the deletion of the tag group."))
html.button("_abort", _("Abort"))
html.button("_do_confirm", _("Proceed"))
html.hidden_fields(add_action_vars=True)
html.end_form()
html.close_div()
elif message:
if isinstance(operations, list):
wato_html_head(_("Confirm tag deletion"))
else:
wato_html_head(_("Confirm tag modifications"))
html.open_div(class_="really")
html.h3(_("Your modifications affect some objects"))
html.write_text(message)
html.br()
html.write_text(
_("WATO can repair things for you. It can rename tags in folders, host and rules. "
"Removed tag groups will be removed from hosts and folders, removed tags will be "
"replaced with the default value for the tag group (for hosts and folders). What "
"rules concern, you have to decide how to proceed."))
html.begin_form("confirm")
# Check if operations contains removal
if isinstance(operations, list):
have_removal = True
else:
have_removal = False
for new_val in operations.values():
if not new_val:
have_removal = True
break
if affected_rulesets and have_removal:
html.br()
html.b(
_("Some tags that are used in rules have been removed by you. What "
"shall we do with that rules?"))
html.open_ul()
html.radiobutton("_repair", "remove", True,
_("Just remove the affected tags from the rules."))
html.br()
html.radiobutton(
"_repair", "delete", False,
_("Delete rules containing tags that have been removed, if tag is used in a positive sense. Just remove that tag if it's used negated."
))
else:
html.open_ul()
html.radiobutton("_repair", "repair", True, _("Fix affected folders, hosts and rules."))
html.br()
html.radiobutton("_repair", "abort", False, _("Abort your modifications."))
html.close_ul()
html.button("_do_confirm", _("Proceed"), "")
html.hidden_fields(add_action_vars=True)
html.end_form()
html.close_div()
return False
return True
def _wato_page_handler(current_mode: str,
mode_permissions: List[PermissionName],
mode_class: Type[WatoMode]) -> None:
try:
init_wato_datastructures(with_wato_lock=not html.is_transaction())
except Exception:
# Snapshot must work in any case
if current_mode == 'snapshot':
pass
else:
raise
# Check general permission for this mode
if mode_permissions is not None and not config.user.may("wato.seeall"):
_ensure_mode_permissions(mode_permissions)
mode = mode_class()
# Do actions (might switch mode)
action_message: Optional[str] = None
if html.is_transaction():
try:
config.user.need_permission("wato.edit")
# Even if the user has seen this mode because auf "seeall",
# he needs an explicit access permission for doing changes:
if config.user.may("wato.seeall"):
if mode_permissions:
_ensure_mode_permissions(mode_permissions)
if cmk.gui.watolib.read_only.is_enabled(
) and not cmk.gui.watolib.read_only.may_override():
raise MKUserError(None, cmk.gui.watolib.read_only.message())
result = mode.action()
if isinstance(result, tuple):
newmode, action_message = result
else:
newmode = result
# We assume something has been modified and increase the config generation ID by one.
update_config_generation()
# If newmode is False, then we shall immediately abort.
# This is e.g. the case, if the page outputted non-HTML
# data, such as a tarball (in the export function). We must
# be sure not to output *any* further data in that case.
if newmode is False:
return
# if newmode is not None, then the mode has been changed
if newmode is not None:
assert not isinstance(newmode, bool)
if newmode == "": # no further information: configuration dialog, etc.
if action_message:
html.show_message(action_message)
wato_html_footer()
return
mode_permissions, mode_class = _get_mode_permission_and_class(
newmode)
current_mode = newmode
mode = mode_class()
html.request.set_var("mode",
newmode) # will be used by makeuri
# Check general permissions for the new mode
if mode_permissions is not None and not config.user.may(
"wato.seeall"):
for pname in mode_permissions:
if '.' not in pname:
pname = "wato." + pname
config.user.need_permission(pname)
except MKUserError as e:
action_message = "%s" % e
html.add_user_error(e.varname, action_message)
except MKAuthException as e:
reason = e.args[0]
action_message = reason
html.add_user_error(None, reason)
breadcrumb = make_main_menu_breadcrumb(
mode.main_menu()) + mode.breadcrumb()
page_menu = mode.page_menu(breadcrumb)
wato_html_head(title=mode.title(),
breadcrumb=breadcrumb,
page_menu=page_menu,
show_body_start=display_options.enabled(display_options.H),
show_top_heading=display_options.enabled(display_options.T))
if not html.is_transaction() or (cmk.gui.watolib.read_only.is_enabled() and
cmk.gui.watolib.read_only.may_override()):
_show_read_only_warning()
# Show outcome of action
if html.has_user_errors():
html.show_user_errors()
elif action_message:
html.show_message(action_message)
# Show content
mode.handle_page()
if is_sidebar_reload_needed():
html.reload_sidebar()
if config.wato_use_git and html.is_transaction():
do_git_commit()
wato_html_footer(show_footer=display_options.enabled(display_options.Z),
show_body_end=display_options.enabled(display_options.H))
