def write_snapin_exception(e: Exception) -> None:
html.open_div(class_=["snapinexception"])
html.h2(_("Error"))
html.p(str(e))
html.div(traceback.format_exc().replace("\n", "<br>"),
style="display:none;")
html.close_div()
def page_add_snapin() -> None:
if not user.may("general.configure_sidebar"):
raise MKGeneralException(
_("You are not allowed to change the sidebar."))
title = _("Add sidebar element")
breadcrumb = make_simple_page_breadcrumb(
mega_menu_registry.menu_customize(), title)
make_header(html, title, breadcrumb, _add_snapins_page_menu(breadcrumb))
used_snapins = _used_snapins()
html.open_div(class_=["add_snapin"])
for name, snapin_class in sorted(snapin_registry.items()):
if name in used_snapins:
continue
if not snapin_class.may_see():
continue # not allowed for this user
html.open_div(
class_="snapinadder",
onmouseover="this.style.cursor='pointer';",
onclick="window.top.cmk.sidebar.add_snapin('%s')" % name,
)
html.open_div(class_=["snapin_preview"])
html.div("", class_=["clickshield"])
SidebarRenderer().render_snapin(
UserSidebarSnapin.from_snapin_type_id(name))
html.close_div()
html.div(snapin_class.description(), class_=["description"])
html.close_div()
html.close_div()
html.footer()
def _show_sidebar(self) -> None:
if not user.may("general.see_sidebar"):
html.div("", id_="check_mk_navigation")
return
user_config = UserSidebarConfig(user, active_config.sidebar)
html.open_div(
id_="check_mk_navigation",
class_="min"
if user.get_attribute("nav_hide_icons_title") else None,
)
self._show_sidebar_head()
html.close_div()
assert user.id is not None
sidebar_position = cmk.gui.userdb.load_custom_attr(
user_id=user.id,
key="ui_sidebar_position",
parser=lambda x: None if x == "None" else "left",
)
html.open_div(
id_="check_mk_sidebar",
class_=[] if sidebar_position is None else [sidebar_position])
self._show_snapin_bar(user_config)
html.close_div()
if user_config.folded:
html.final_javascript("cmk.sidebar.fold_sidebar();")
def show_job_class_infos(cls, job_class_infos, **kwargs):
"""Renders all jobs from the job_class_infos in a single multi-table"""
html.open_table(css="job_table data")
for job_class, jobs_info in sorted(job_class_infos.items(),
key=lambda x: x[0].gui_title()):
html.open_tr()
html.open_td(colspan=len(cls.get_headers()))
html.h3(job_class.gui_title())
html.close_td()
html.close_tr()
if not jobs_info:
html.open_tr()
html.open_td(colspan=len(cls.get_headers()))
html.div(_("No entries"), css="info")
html.close_td()
html.close_tr()
continue
cls.show_job_row_headers()
odd = "even"
for job_id, job_status in sorted(jobs_info.items(),
key=lambda x: x[1]["started"],
reverse=True):
cls.render_job_row(job_id, job_status, odd, **kwargs)
odd = "even" if odd == "odd" else "odd"
def render_wato(mini):
if not active_config.wato_enabled:
html.write_text(_("Setup is disabled."))
return False
if not user.may("wato.use"):
html.write_text(_("You are not allowed to use the setup."))
return False
menu = get_wato_menu_items()
if mini:
for topic in menu:
for item in topic.items:
html.icon_button(
url=item.url,
class_=["show_more_mode"] if item.is_show_more else [],
title=item.title,
icon=item.icon or "wato",
target="main",
)
else:
show_topic_menu(treename="wato", menu=menu, show_item_icons=True)
pending_info = get_pending_changes_info()
if pending_info:
footnotelinks([(pending_info, "wato.py?mode=changelog")])
html.div("", class_="clear")
return None
def page(self) -> cmk.gui.pages.PageResult:
breadcrumb = make_simple_page_breadcrumb(
mega_menu_registry["help_links"], _("Info"))
make_header(
html,
self._title(),
breadcrumb=breadcrumb,
)
html.open_div(id_="info_title")
html.h1(_("Your monitoring machine"))
html.a(
HTMLWriter.render_img(theme.url("images/tribe29.svg")),
"https://tribe29.com",
target="_blank",
)
html.close_div()
html.div(None, id_="info_underline")
html.open_div(id_="info_intro_text")
html.span(_("Open. Effective. Awesome."))
html.span(
_("May we present? Monitoring as it's supposed to be: "
"incredibly quick to install, infinetely scalable, highly customizable and "
"designed for admins."))
html.span(
_("Visit our %s to learn more about Checkmk and about the %s.") % (
HTMLWriter.render_a(
_("website"), "https://checkmk.com", target="_blank"),
HTMLWriter.render_a(
_("latest version"),
"https://checkmk.com/product/latest-version",
target="_blank",
),
))
html.close_div()
version_major_minor = re.sub(r".\d+$", "",
Version(__version__).version_base)
if version_major_minor:
current_version_link = "https://checkmk.com/product/checkmk-%s" % version_major_minor
else:
current_version_link = "https://checkmk.com/product/latest-version"
html.open_div(id="info_image")
html.open_a(href=current_version_link, target="_blank")
html.img(theme.url("images/monitoring-machine.png"))
html.close_a()
html.close_div()
html.close_div()
html.open_div(id_="info_footer")
html.span(
_("© %s tribe29 GmbH. All Rights Reserved.") % time.strftime("%Y"))
html.a(_("License agreement"),
href="https://checkmk.com/legal.html",
target="_blank")
html.close_div()
def js_dashlet(self, figure_type_name: str) -> None:
fetch_url = "ajax_figure_dashlet_data.py"
div_id = "%s_dashlet_%d" % (self.type_name(), self._dashlet_id)
html.div("", id_=div_id)
# TODO: Would be good to align this scheme with AjaxPage.webapi_request()
# (a single HTTP variable "request=<json-body>".
post_body = urlencode_vars(self._dashlet_http_variables())
html.javascript(
"""
let figure_%(dashlet_id)d = cmk.figures.figure_registry.get_figure(%(type_name)s);
let %(instance_name)s = new figure_%(dashlet_id)d(%(div_selector)s);
%(instance_name)s.set_post_url_and_body(%(url)s, %(body)s);
%(instance_name)s.initialize();
%(instance_name)s.scheduler.set_update_interval(%(update)d);
%(instance_name)s.scheduler.enable();
""" % {
"type_name": json.dumps(figure_type_name),
"dashlet_id": self._dashlet_id,
"instance_name": self.instance_name,
"div_selector": json.dumps("#%s" % div_id),
"url": json.dumps(fetch_url),
"body": json.dumps(post_body),
"update": self.update_interval,
})
def _show_form(self) -> None:
assert user.id is not None
credentials = load_two_factor_credentials(user.id)
webauthn_credentials = credentials["webauthn_credentials"]
backup_codes = credentials["backup_codes"]
html.begin_form("two_factor", method="POST")
html.div("", id_="webauthn_message")
forms.header(_("Credentials"))
forms.section(_("Registered credentials"), simple=True)
if webauthn_credentials:
self._show_credentials(webauthn_credentials)
else:
html.i(_("No credentials registered"))
forms.section(_("Backup codes"), simple=True)
if backup_codes:
html.p(
_("You have %d unused backup codes left. You can use them as one-time password "
"if your key is not available.") % len(backup_codes))
html.i(
_("If you regenerate backup codes, you automatically invalidate the existing codes."
))
else:
html.i(_("No backup codes created yet."))
forms.end()
html.hidden_fields()
html.end_form()
html.footer()
def _show_content(self, page_state: PageState) -> None:
html.div(page_state.text, class_="text_container")
if page_state.icon_name:
html.div(
html.render_icon(page_state.icon_name, id_="page_state_icon"),
class_="icon_container",
)
def create_graph(name, size, bounds, v_range, legend):
html.open_table(class_="prediction")
html.open_tr()
html.open_td()
html.canvas(
"",
class_="prediction",
id_="content_%s" % name,
style="width: %dpx; height: %dpx;" %
(int(size[0] / 2.0), int(size[1] / 2.0)),
width=size[0],
height=size[1],
)
html.close_td()
html.close_tr()
html.open_tr()
html.open_td(class_="legend")
for color, title in legend:
html.div("", class_="color", style="background-color: %s" % color)
html.div(title, class_="entry")
html.close_td()
html.close_tr()
html.close_table()
html.javascript(
'cmk.prediction.create_graph("content_%s", %.4f, %.4f, %.4f, %.4f);' %
(name, bounds[0], bounds[1], v_range[0], v_range[1]))
def _show_main_menu_content(self) -> None:
for menu_item in self._get_main_menu_items():
if isinstance(menu_item.icon, dict):
active_icon: Icon = {
"icon": menu_item.icon["icon"] + "_active",
"emblem": menu_item.icon["emblem"],
}
else:
active_icon = menu_item.icon + "_active"
html.open_li()
html.popup_trigger(
(self._get_popup_trigger_content(active_icon, menu_item)),
ident="mega_menu_" + menu_item.name,
method=MethodInline(self._get_mega_menu_content(menu_item)),
cssclass=[menu_item.name],
popup_group="main_menu_popup",
hover_switch_delay=150, # ms
onopen=menu_item.onopen,
)
html.div(
"",
id_="popup_shadow",
onclick="cmk.popup_menu.close_popup()",
class_="min"
if user.get_attribute("nav_hide_icons_title") else None,
)
html.close_li()
def do_log_ack(site, host_name, file_name):
sites.live().set_auth_domain("action")
logs_to_ack = []
if not host_name and not file_name: # all logs on all hosts
for this_site, this_host, logs in all_logs():
for int_filename in logs:
file_display = form_file_to_ext(int_filename)
logs_to_ack.append(
(this_site, this_host, int_filename, file_display))
elif host_name and not file_name: # all logs on one host
for int_filename in logfiles_of_host(site, host_name):
file_display = form_file_to_ext(int_filename)
logs_to_ack.append((site, host_name, int_filename, file_display))
elif host_name and file_name: # one log on one host
int_filename = form_file_to_int(file_name)
logs_to_ack = [(site, host_name, int_filename,
form_file_to_ext(int_filename))]
else:
for this_site, this_host, logs in all_logs():
file_display = form_file_to_ext(file_name)
if file_name in logs:
logs_to_ack.append(
(this_site, this_host, file_name, file_display))
ack_msg = _get_ack_msg(host_name, file_name)
ack = request.var("_ack")
if not user.may("general.act"):
html.h1(_("Permission denied"), class_=["error"])
html.div(_("You are not allowed to acknowledge %s") % ack_msg,
class_=["error"])
html.footer()
return
# filter invalid values
if ack != "1":
raise MKUserError("_ack", _("Invalid value for ack parameter."))
for this_site, this_host, int_filename, display_name in logs_to_ack:
try:
acknowledge_logfile(this_site, this_host, int_filename,
display_name)
except Exception as e:
html.show_error(
_("The log file <tt>%s</tt> of host <tt>%s</tt> could not be deleted: %s."
) % (display_name, this_host, e))
html.footer()
return
html.show_message("<b>%s</b><p>%s</p>" %
(_("Acknowledged %s") % ack_msg,
_("Acknowledged all messages in %s.") % ack_msg))
html.footer()
def _show_webauthn_credentials(
self, webauthn_credentials: dict[str, WebAuthnCredential]) -> None:
html.div("", id_="webauthn_message")
forms.header(_("WebAuthn credentials"))
forms.section(_("Registered credentials"), simple=True)
if webauthn_credentials:
self._show_credentials(webauthn_credentials)
else:
html.i(_("No credentials registered"))
forms.end()
def show_topology_content(self, topology_settings: TopologySettings) -> None:
div_id = "node_visualization"
html.div("", id_=div_id)
html.javascript(
"topology_instance = new cmk.node_visualization.TopologyVisualization(%s);"
% json.dumps(div_id)
)
html.javascript(
"topology_instance.show_topology(%s)"
% json.dumps(TopologySettingsJSON(**asdict(topology_settings)).to_json())
)
def show(self):
html.open_div(class_="mainmenu")
for item in self._items:
if not item.may_see():
continue
html.open_a(href=item.get_url(),
onfocus="if (this.blur) this.blur();")
html.icon(item.icon, item.title)
html.div(item.title, class_="title")
html.div(item.description, class_="subtitle")
html.close_a()
html.close_div()
def test_HTMLWriter(request_context):
with output_funnel.plugged():
with output_funnel.plugged():
html.open_div()
text = output_funnel.drain()
assert text.rstrip("\n").rstrip(" ") == "<div>"
with output_funnel.plugged():
# html.open_div().write("test").close_div()
html.open_div()
html.write_text("test")
html.close_div()
assert compare_html(output_funnel.drain(), "<div>test</div>")
with output_funnel.plugged():
# html.open_table().open_tr().td("1").td("2").close_tr().close_table()
html.open_table()
html.open_tr()
html.td("1")
html.td("2")
html.close_tr()
html.close_table()
assert compare_html(
output_funnel.drain(),
"<table><tr><td>1</td><td>2</td></tr></table>")
with output_funnel.plugged():
html.div("test", **{"</div>malicious_code<div>": "trends"})
assert compare_html(
output_funnel.drain(),
"<div </div>malicious_code<div>=trends>test</div>",
)
a = "\u2665"
with output_funnel.plugged():
assert HTMLWriter.render_a("test", href="www.test.case")
HTMLWriter.render_a("test", href="www.test.case")
HTMLWriter.render_a("test", href="www.test.case")
HTMLWriter.render_a("test", href="www.test.case")
try:
assert HTMLWriter.render_a(
"test",
href=str("www.test.case"),
id_=str("something"),
class_=str("test_%s") % a,
)
except Exception as e:
traceback.print_exc()
print(e)
def _show_diagnose_output(self):
if not request.var("_save"):
html.show_message(
_(
"You can diagnose the connection to a specific host using this dialog. "
"You can either test whether your current configuration is still working "
"or investigate in which ways a host can be reached. Simply configure the "
"connection options you like to try on the right side of the screen and "
'press the "Test" button. The results will be displayed here.'
)
)
return
if user_errors:
html.show_user_errors()
return
# TODO: Insert any vs_host valuespec validation
# These tests can be called with invalid valuespec settings...
# TODO: Replace hard coded icon paths with dynamic ones to old or new theme
for ident, title in ModeDiagHost.diag_host_tests():
html.h3(title)
html.open_table(class_=["data", "test"])
html.open_tr(class_=["data", "odd0"])
html.open_td(class_="icons")
html.open_div()
html.icon("reload", id_="%s_img" % ident)
html.open_a(href="")
html.icon(
"reload", title=_("Retry this test"), cssclass="retry", id_="%s_retry" % ident
)
html.close_a()
html.close_div()
html.close_td()
html.open_td()
html.div("", class_="log", id="%s_log" % ident)
html.close_td()
html.close_tr()
html.close_table()
html.javascript(
"cmk.host_diagnose.start_test(%s, %s, %s)"
% (
json.dumps(ident),
json.dumps(self._hostname),
json.dumps(transactions.fresh_transid()),
)
)
def _show_topic(self, topic: PageMenuTopic) -> None:
html.open_div(class_="topic")
html.div(
topic.title,
class_=["topic_title"]
+ (["show_more_mode"] if all(entry.is_show_more for entry in topic.entries) else []),
)
for entry in topic.entries:
if not entry.is_list_entry:
continue
self._show_entry(entry)
html.close_div()
def _bi_map() -> None:
aggr_name = request.var("aggr_name")
layout_id = request.var("layout_id")
title = _("BI visualization")
breadcrumb = make_simple_page_breadcrumb(mega_menu_registry.menu_monitoring(), title)
make_header(html, title, breadcrumb)
div_id = "node_visualization"
html.div("", id=div_id)
html.javascript(
"node_instance = new cmk.node_visualization.BIVisualization(%s);" % json.dumps(div_id)
)
html.javascript(
"node_instance.show_aggregations(%s, %s)" % (json.dumps([aggr_name]), json.dumps(layout_id))
)
def render_werk_description(werk) -> HTML:
with output_funnel.plugged():
html.open_p()
in_list = False
in_code = False
for line in werk["body"]:
if line.startswith("LI:"):
if not in_list:
html.open_ul()
in_list = True
html.li(line[3:])
else:
if in_list:
html.close_ul()
in_list = False
if line.startswith("H2:"):
html.h3(line[3:])
elif line.startswith("C+:"):
html.open_pre(class_="code")
in_code = True
elif line.startswith("F+:"):
file_name = line[3:]
if file_name:
html.div(file_name, class_="filename")
html.open_pre(class_="file")
in_code = True
elif line.startswith("C-:") or line.startswith("F-:"):
html.close_pre()
in_code = False
elif line.startswith("OM:"):
html.write_text("OMD[mysite]:~$ ")
html.b(line[3:])
elif line.startswith("RP:"):
html.write_text("root@myhost:~# ")
html.b(line[3:])
elif not line.strip() and not in_code:
html.p("")
else:
html.write_text(line + "\n")
if in_list:
html.close_ul()
html.close_p()
return HTML(output_funnel.drain())
def user_profile_async_replication_dialog(sites: Sequence[SiteId],
back_url: str) -> None:
html.p(
_("In order to activate your changes available on all remote sites, your user profile needs "
"to be replicated to the remote sites. This is done on this page now. Each site "
"is being represented by a single image which is first shown gray and then fills "
"to green during synchronisation."))
html.h3(_("Replication States"))
html.open_div(id_="profile_repl")
num_replsites = 0
for site_id in sites:
site = active_config.sites[site_id]
if "secret" not in site:
status_txt = _("Not logged in.")
start_sync = False
icon = "repl_locked"
else:
status_txt = _("Waiting for replication to start")
start_sync = True
icon = "repl_pending"
html.open_div(class_="site", id_="site-%s" % site_id)
html.div("", title=status_txt, class_=["icon", "repl_status", icon])
if start_sync:
changes_manager = ActivateChanges()
changes_manager.load()
estimated_duration = changes_manager.get_activation_time(
site_id, ACTIVATION_TIME_PROFILE_SYNC, 2.0)
html.javascript("cmk.profile_replication.start(%s, %d, %s);" % (
json.dumps(site_id),
int(estimated_duration * 1000.0),
json.dumps(_("Replication in progress")),
))
num_replsites += 1
else:
_add_profile_replication_change(site_id, status_txt)
html.span(site.get("alias", site_id))
html.close_div()
html.javascript("cmk.profile_replication.prepare(%d, %s);\n" %
(num_replsites, json.dumps(back_url)))
html.close_div()
def _show_sidebar_head(self):
html.open_div(id_="side_header")
html.open_a(
href=user.start_url or active_config.start_url,
target="main",
title=_("Go to main page"),
)
_render_header_icon()
html.close_a()
html.close_div()
MainMenuRenderer().show()
html.open_div(id_="side_fold",
title=_("Toggle the sidebar"),
onclick="cmk.sidebar.toggle_sidebar()")
html.icon("sidebar_folded", class_=["folded"])
html.icon("sidebar")
if not user.get_attribute("nav_hide_icons_title"):
html.div(_("Sidebar"))
html.close_div()
def _download_table(self, title: str, paths: List[str]) -> None:
forms.header(title)
forms.container()
for path in paths:
os_path = path
relpath = path.replace(cmk.utils.paths.agents_dir + "/", "")
filename = path.split("/")[-1]
file_size = os.stat(os_path).st_size
# FIXME: Rename classes etc. to something generic
html.open_div(class_="ruleset")
html.open_div(style="width:300px;", class_="text")
html.a(filename, href="agents/%s" % relpath, download=filename)
html.span("." * 200, class_="dots")
html.close_div()
html.div(cmk.utils.render.fmt_bytes(file_size),
style="width:60px;",
class_="rulecount")
html.close_div()
html.close_div()
forms.end()
def _show_table(self, api_request):
html.open_table(class_="allhosts")
html.open_tbody()
for map_cfg in api_request["maps"]:
html.open_tr()
html.open_td()
html.div(
"",
class_=[
"statebullet",
self._state_class(map_cfg),
self._sub_state_class(map_cfg),
self._stale_class(map_cfg),
],
title=self._state_title(map_cfg),
)
html.a(map_cfg["alias"], href=map_cfg["url"], class_="link", target="main")
html.close_td()
html.close_tr()
html.close_tbody()
html.close_table()
def page(self):
if not self._attrs:
html.div(_("No custom attributes are defined yet."), class_="info")
return
with table_element(self._type + "attrs") as table:
for custom_attr in sorted(self._attrs, key=lambda x: x["title"]):
table.row()
table.cell(_("Actions"), css=["buttons"])
edit_url = folder_preserving_link(
[("mode", "edit_%s_attr" % self._type), ("edit", custom_attr["name"])]
)
delete_url = make_confirm_link(
url=makeactionuri(request, transactions, [("_delete", custom_attr["name"])]),
message=_('Do you really want to delete the custom attribute "%s"?')
% custom_attr["name"],
)
html.icon_button(edit_url, _("Properties"), "edit")
html.icon_button(delete_url, _("Delete"), "delete")
table.cell(_("Name"), custom_attr["name"])
table.cell(_("Title"), custom_attr["title"])
table.cell(_("Type"), dict(custom_attr_types())[custom_attr["type"]])
def page_login() -> None:
title = _("Checkmk Mobile")
mobile_html_head(title)
jqm_page_header(title, id_="login")
html.div(_("Welcome to Checkmk Mobile."), id_="loginhead")
html.begin_form("login", method="POST", add_transid=False)
# Keep information about original target URL
default_origtarget = (
"index.py" if requested_file_name(request) in ["login", "logout"] else makeuri(request, [])
)
origtarget = request.get_url_input("_origtarget", default_origtarget)
html.hidden_field("_origtarget", escaping.escape_attribute(origtarget))
html.text_input("_username", label=_("Username:"******"username", id_="input_user")
html.password_input(
"_password",
size=None,
label=_("Password:"******"current-password",
id_="input_pass",
)
html.br()
html.button("_login", _("Login"))
html.set_focus("_username")
html.end_form()
html.open_div(id_="loginfoot")
html.img("themes/facelift/images/logo_cmk_small.png", class_="logomk")
html.div(
HTML(_('© <a target="_blank" href="https://checkmk.com">tribe29 GmbH</a>')),
class_="copyright",
)
html.close_div() # close content-div
html.close_div()
html.close_div() # close page-div
mobile_html_foot()
def show(self):
if self._init_exception:
raise self._init_exception
html.div("", id_="dashlet_graph_%d" % self._dashlet_id)
def show(self):
html.div(_("Loading maps..."), class_="loading")
html.javascript("cmk.sidebar.fetch_nagvis_snapin_contents()")
def _end(self) -> None:
if not self.rows and self.options["omit_if_empty"]:
return
if self.options["output_format"] == "csv":
self._write_csv(csv_separator=request.get_str_input_mandatory(
"csv_separator", ";"))
return
container: ContextManager[bool] = nullcontext(False)
if self.title:
if self.options["foldable"] in [
Foldable.FOLDABLE_SAVE_STATE,
Foldable.FOLDABLE_STATELESS,
]:
html.open_div(class_="foldable_wrapper")
container = foldable_container(
treename="table",
id_=self.id,
isopen=self.isopen,
indent=False,
title=HTMLWriter.render_h3(self.title,
class_=["treeangle", "title"]),
save_state=self.options["foldable"] ==
Foldable.FOLDABLE_SAVE_STATE,
)
else:
html.h3(self.title, class_="table")
with container:
if self.help:
html.help(self.help)
if not self.rows:
html.div(self.empty_text, class_="info")
return
# Controls whether or not actions are available for a table
rows, actions_visible, search_term = self._evaluate_user_opts()
# Apply limit after search / sorting etc.
num_rows_unlimited = len(rows)
limit = self.limit
if limit:
# only use rows up to the limit plus the fixed rows
limited_rows = []
for index in range(num_rows_unlimited):
row = rows[index]
if index < limit or isinstance(row,
GroupHeader) or row.fixed:
limited_rows.append(row)
# Display corrected number of rows
num_rows_unlimited -= len([
r for r in limited_rows
if isinstance(row, GroupHeader) or r.fixed
])
rows = limited_rows
# Render header
if self.limit_hint is not None:
num_rows_unlimited = self.limit_hint
if limit and num_rows_unlimited > limit:
html.show_message(
_("This table is limited to show only %d of %d rows. "
'Click <a href="%s">here</a> to disable the limitation.')
% (limit, num_rows_unlimited,
makeuri(request, [("limit", "none")])))
self._write_table(rows, num_rows_unlimited,
self._show_action_row(), actions_visible,
search_term)
if self.title and self.options["foldable"] in [
Foldable.FOLDABLE_SAVE_STATE,
Foldable.FOLDABLE_STATELESS,
]:
html.close_div()
return
def _page_no_groups(self) -> None:
html.div(_("No groups are defined yet."), class_="info")
