b37528f5d6
ClientboundServerLinksPacket (configuration and play) decoded and kept, the pause menu gains its "Server Links..." button when a server sends links, opening the server_links dialog screen: scrollable link buttons, ConfirmLinkScreen on click (chatLinks/chatLinksPrompt honoured), and the custom-screens warning with its disconnect. A dedicated server sends its `bug-report-link` property as the BUG_REPORT link, like vanilla. Co-Authored-By: Devin <158243242+devin-ai-integration[bot]@users.noreply.github.com>
488 lines
17 KiB
Rust
488 lines
17 KiB
Rust
//! `ServerLinksDialogScreen`: the pause menu's "Server Links..." button opens
|
|
//! the `minecraft:server_links` dialog (the `pause_screen_additions` tag's
|
|
//! fallback when a server sent ClientboundServerLinksPacket): a scrollable
|
|
//! list of the server's links, each opened through `ConfirmLinkScreen`
|
|
//! (Screen.clickUrlAction), and the `dialog/warning_button`'s
|
|
//! DialogScreen.WarningScreen ("Note about custom screens").
|
|
//! https://mcsrc.dev/2/26.3/net/minecraft/client/gui/screens/dialog/ServerLinksDialogScreen
|
|
use super::{Game, Screen, packs::open_uri};
|
|
use horizon_client::{Result, clipboard::Clipboard, hud::HudBatch, text::Text, ui};
|
|
use horizon_protocol::packets::configuration::{ServerLink, ServerLinkKind};
|
|
|
|
/// HeaderAndFooterLayout's header and footer heights; the content wants to
|
|
/// start 30 pixels under the header (its `CONTENTS_MARGIN_TOP`).
|
|
const HEADER: f32 = 33.0;
|
|
const FOOTER: f32 = 33.0;
|
|
const CONTENT_TOP: f32 = HEADER + 30.0;
|
|
/// `server_links.json`: `columns` 1, `button_width` 310, `exit_action`'s 200.
|
|
const LINK_WIDTH: f32 = 310.0;
|
|
/// packControlsIntoColumns: rowSpacing 2 under the 20-pixel buttons.
|
|
const ROW: f32 = 22.0;
|
|
/// ScrollableLayout's BOTH reserve (scrollbarSpacing 4 + SCROLLBAR_WIDTH 6).
|
|
const SCROLL_RESERVE: f32 = 10.0;
|
|
/// DialogScreen's `dialog/warning_button` ImageButton.
|
|
const WARNING_BUTTON: f32 = 20.0;
|
|
|
|
/// The ServerLinks screen's state: ScrollableLayout's scroll and the link
|
|
/// ConfirmLinkScreen is asking about (`Screen::ConfirmLink`).
|
|
#[derive(Default)]
|
|
pub(super) struct LinksUi {
|
|
pub scroll: f32,
|
|
pub confirm: Option<String>,
|
|
}
|
|
|
|
/// `Util.parseAndValidateUntrustedUri`: an absolute `http`/`https` URI
|
|
/// (java.net.URI's scheme then the allowlist; whitespace-free).
|
|
pub(super) fn valid_untrusted_uri(uri: &str) -> bool {
|
|
let Some(colon) = uri.find(':') else {
|
|
return false;
|
|
};
|
|
let scheme = &uri[..colon];
|
|
let mut chars = scheme.chars();
|
|
if !chars.next().is_some_and(|c| c.is_ascii_alphabetic())
|
|
|| !chars.all(|c| c.is_ascii_alphanumeric() || matches!(c, '+' | '-' | '.'))
|
|
{
|
|
return false;
|
|
}
|
|
if !matches!(scheme.to_ascii_lowercase().as_str(), "http" | "https") {
|
|
return false;
|
|
}
|
|
!uri.chars().any(|c| c.is_control() || c == ' ')
|
|
}
|
|
/// `ClientCommonPacketListenerImpl.handleServerLinks`: keep only the links
|
|
/// that validate, warning about the dropped ones.
|
|
pub(super) fn trusted(links: Vec<ServerLink>) -> Vec<ServerLink> {
|
|
links
|
|
.into_iter()
|
|
.filter(|l| {
|
|
let ok = valid_untrusted_uri(&l.link);
|
|
if !ok {
|
|
log::warn!("Horizon: server sent an invalid link: {}", l.link);
|
|
}
|
|
ok
|
|
})
|
|
.collect()
|
|
}
|
|
/// `ServerLinks.Entry.displayName`: `known_server_link.<name>` for a known
|
|
/// type (ByIdMap.ZERO reads unknown ids as `report_bug`), the component else.
|
|
fn link_label(link: &ServerLink) -> Text {
|
|
const KNOWN: [&str; 10] = [
|
|
"report_bug",
|
|
"community_guidelines",
|
|
"support",
|
|
"status",
|
|
"feedback",
|
|
"community",
|
|
"website",
|
|
"forums",
|
|
"news",
|
|
"announcements",
|
|
];
|
|
match &link.kind {
|
|
ServerLinkKind::Known(id) => Text::translate(
|
|
&format!(
|
|
"known_server_link.{}",
|
|
KNOWN.get(*id as usize).copied().unwrap_or(KNOWN[0])
|
|
),
|
|
&[],
|
|
),
|
|
ServerLinkKind::Custom(tag) => {
|
|
horizon_client::scoreboard::comp_text(&horizon_client::scoreboard::tag_to_json(tag))
|
|
}
|
|
}
|
|
}
|
|
|
|
/// The scrolled column of link buttons: content height and, for a list that
|
|
/// fits, the `HeaderAndFooterLayout` contents frame's top.
|
|
fn list_height(n: usize) -> f32 {
|
|
n as f32 * ROW - 2.0
|
|
}
|
|
fn list_top(h: f32, n: usize) -> f32 {
|
|
CONTENT_TOP.min(h - FOOTER - list_height(n).min(h - HEADER - FOOTER))
|
|
}
|
|
fn scroll_limit(h: f32, n: usize) -> f32 {
|
|
(list_height(n) - (h - HEADER - FOOTER)).max(0.0)
|
|
}
|
|
|
|
/// `ServerLinksScreen`'s buttons as (x, y) over the scrolled content, and the
|
|
/// footer `Back` button's corner. `top` includes the scroll.
|
|
fn link_buttons(w: f32, top: f32, n: usize) -> Vec<(f32, f32)> {
|
|
let x = ((w - LINK_WIDTH - 2.0 * SCROLL_RESERVE) / 2.0 + SCROLL_RESERVE).floor();
|
|
(0..n).map(|i| (x, top + i as f32 * ROW)).collect()
|
|
}
|
|
/// The warning button beside the title (DialogScreen's title row: 10 pixels
|
|
/// apart), clamped onto the screen (makeSureWarningButtonIsInBounds).
|
|
fn warning_button(w: f32, h: f32, title_width: f32) -> (f32, f32) {
|
|
let x = ((w - title_width - 30.0) / 2.0).floor() + title_width + 10.0;
|
|
let y = ((HEADER - WARNING_BUTTON) / 2.0).floor();
|
|
if x < 0.0 || y < 0.0 || x > w - WARNING_BUTTON || y > h - WARNING_BUTTON {
|
|
(0.0f32.max(w - 40.0), 5.0f32.min(h))
|
|
} else {
|
|
(x, y)
|
|
}
|
|
}
|
|
fn back_button(w: f32, h: f32) -> (f32, f32) {
|
|
(
|
|
((w - 200.0) / 2.0).floor(),
|
|
h - FOOTER + ((FOOTER - 20.0) / 2.0).floor(),
|
|
)
|
|
}
|
|
|
|
impl Game<'_> {
|
|
/// `connection.serverLinks()`: the links the open server sent (empty for
|
|
/// a world without a connection or one that sent none).
|
|
pub(super) fn server_links(&self) -> &[ServerLink] {
|
|
self.remote
|
|
.as_ref()
|
|
.map_or(&[], |r| r.server_links.as_slice())
|
|
}
|
|
/// DialogScreen over the pause menu: `menu.server_links.title`, the
|
|
/// scrollable link buttons and `gui.back` in the footer.
|
|
pub(super) fn draw_server_links(&mut self, batch: &mut HudBatch) {
|
|
let atlas = &self.gui.atlas;
|
|
let (w, h) = (batch.width, batch.height);
|
|
ui::menu_background(batch, atlas, 0.0, 0.0, w, h, true);
|
|
let links = self.server_links().to_vec();
|
|
self.links_ui.scroll = self
|
|
.links_ui
|
|
.scroll
|
|
.clamp(0.0, scroll_limit(h, links.len()));
|
|
let top = list_top(h, links.len()) - self.links_ui.scroll.trunc();
|
|
// The title row: the title, then 10 pixels on the warning button.
|
|
let title = Text::translate("menu.server_links.title", &[]);
|
|
let tw = atlas.font.width_text(&title);
|
|
let tx = ((w - tw - 30.0) / 2.0).floor();
|
|
batch.text_styled(atlas, &title, tx, 12.0, u32::MAX, true);
|
|
let (wx, wy) = warning_button(w, h, tw);
|
|
let wh = ui::hovered(self.cursor, wx, wy, WARNING_BUTTON, WARNING_BUTTON);
|
|
horizon_client::widgets::record(
|
|
"menu.custom_screen_info.tooltip",
|
|
[wx, wy, WARNING_BUTTON, WARNING_BUTTON],
|
|
true,
|
|
);
|
|
batch.sprite_scaled(
|
|
atlas,
|
|
if wh {
|
|
"gui/sprites/dialog/warning_button_highlighted"
|
|
} else {
|
|
"gui/sprites/dialog/warning_button"
|
|
},
|
|
wx,
|
|
wy,
|
|
WARNING_BUTTON,
|
|
WARNING_BUTTON,
|
|
u32::MAX,
|
|
);
|
|
let first = batch.vertices.len();
|
|
let inside = self.cursor.1 >= HEADER && self.cursor.1 < h - FOOTER;
|
|
for (link, (x, y)) in links.iter().zip(link_buttons(w, top, links.len())) {
|
|
let hover = inside && ui::hovered(self.cursor, x, y, LINK_WIDTH, 20.0);
|
|
ui::button(
|
|
batch,
|
|
atlas,
|
|
x,
|
|
y,
|
|
LINK_WIDTH,
|
|
20.0,
|
|
&link_label(link),
|
|
true,
|
|
hover,
|
|
);
|
|
}
|
|
batch.clip_since(first, 0.0, HEADER, w, h - FOOTER);
|
|
ui::scrollbar(
|
|
batch,
|
|
atlas,
|
|
(w / 2.0).floor() + 155.0 + 4.0,
|
|
HEADER,
|
|
h - FOOTER,
|
|
list_height(links.len()),
|
|
self.links_ui.scroll.trunc(),
|
|
);
|
|
let (bx, by) = back_button(w, h);
|
|
let hover = ui::hovered(self.cursor, bx, by, 200.0, 20.0);
|
|
ui::button(
|
|
batch,
|
|
atlas,
|
|
bx,
|
|
by,
|
|
200.0,
|
|
20.0,
|
|
&Text::translate("gui.back", &[]),
|
|
true,
|
|
hover,
|
|
);
|
|
if wh {
|
|
ui::tooltip(
|
|
batch,
|
|
atlas,
|
|
&[Text::translate("menu.custom_screen_info.tooltip", &[])],
|
|
self.cursor,
|
|
);
|
|
}
|
|
}
|
|
/// A click on `Screen::ServerLinks`: a link, the warning button or Back.
|
|
pub(super) fn server_links_click(&mut self) -> Result<()> {
|
|
let (w, h) = self.gui_size();
|
|
let links = self.server_links().to_vec();
|
|
let top = list_top(h, links.len()) - self.links_ui.scroll.trunc();
|
|
let inside = self.cursor.1 >= HEADER && self.cursor.1 < h - FOOTER;
|
|
if inside
|
|
&& let Some(i) = link_buttons(w, top, links.len())
|
|
.iter()
|
|
.position(|(x, y)| ui::hovered(self.cursor, *x, *y, LINK_WIDTH, 20.0))
|
|
{
|
|
self.audio.play_button_click();
|
|
self.click_link(&links[i].link);
|
|
return Ok(());
|
|
}
|
|
let title = Text::translate("menu.server_links.title", &[]);
|
|
let tw = self.gui.atlas.font.width_text(&title);
|
|
let (wx, wy) = warning_button(w, h, tw);
|
|
if ui::hovered(self.cursor, wx, wy, WARNING_BUTTON, WARNING_BUTTON) {
|
|
self.audio.play_button_click();
|
|
self.screen = Screen::DialogWarning;
|
|
return Ok(());
|
|
}
|
|
let (bx, by) = back_button(w, h);
|
|
if ui::hovered(self.cursor, bx, by, 200.0, 20.0) {
|
|
self.audio.play_button_click();
|
|
self.screen = Screen::Paused;
|
|
}
|
|
Ok(())
|
|
}
|
|
/// `Screen.clickUrlAction`: "Web Links" off ignores the click; "Prompt on
|
|
/// Links" asks with ConfirmLinkScreen, else the browser opens directly.
|
|
fn click_link(&mut self, url: &str) {
|
|
if !self.settings.chat_links {
|
|
return;
|
|
}
|
|
if self.settings.chat_links_prompt {
|
|
self.links_ui.confirm = Some(url.to_owned());
|
|
self.screen = Screen::ConfirmLink;
|
|
} else {
|
|
open_uri(url);
|
|
}
|
|
}
|
|
/// `ScrollableLayout`'s mouse wheel over the links.
|
|
pub(super) fn server_links_scroll(&mut self, delta: f32) {
|
|
let (_, h) = self.gui_size();
|
|
self.links_ui.scroll = (self.links_ui.scroll - delta * 10.0)
|
|
.clamp(0.0, scroll_limit(h, self.server_links().len()));
|
|
}
|
|
/// `ConfirmLinkScreen` (untrusted): "Are you sure you want to open the
|
|
/// following website?", the link, the red warning, and Yes / Copy Link to
|
|
/// Clipboard / No.
|
|
pub(super) fn draw_confirm_link(&mut self, batch: &mut HudBatch) {
|
|
let atlas = &self.gui.atlas;
|
|
let (w, h) = (batch.width, batch.height);
|
|
ui::menu_background(batch, atlas, 0.0, 0.0, w, h, true);
|
|
let url = self.links_ui.confirm.clone().unwrap_or_default();
|
|
let layout = confirm_link_layout(atlas, (w, h), &url);
|
|
for (line, x, y) in &layout.lines {
|
|
batch.text_styled(atlas, line, *x, *y, u32::MAX, true);
|
|
}
|
|
let labels = ["gui.yes", "gui.copy_link_to_clipboard", "gui.no"];
|
|
for ((x, y), key) in layout.buttons.iter().zip(labels) {
|
|
let hover = ui::hovered(self.cursor, *x, *y, 100.0, 20.0);
|
|
ui::button(
|
|
batch,
|
|
atlas,
|
|
*x,
|
|
*y,
|
|
100.0,
|
|
20.0,
|
|
&Text::translate(key, &[]),
|
|
true,
|
|
hover,
|
|
);
|
|
}
|
|
}
|
|
/// ConfirmLinkScreen's answer: yes opens the browser, the middle button
|
|
/// copies the link, no closes; all return to Server Links.
|
|
pub(super) fn confirm_link_click(&mut self) {
|
|
let (w, h) = self.gui_size();
|
|
let url = self.links_ui.confirm.clone().unwrap_or_default();
|
|
let layout = confirm_link_layout(&self.gui.atlas, (w, h), &url);
|
|
for (i, (x, y)) in layout.buttons.iter().enumerate() {
|
|
if !ui::hovered(self.cursor, *x, *y, 100.0, 20.0) {
|
|
continue;
|
|
}
|
|
self.audio.play_button_click();
|
|
match i {
|
|
0 => open_uri(&url),
|
|
1 => {
|
|
self.clipboard.set(&url);
|
|
}
|
|
_ => {}
|
|
}
|
|
self.screen = Screen::ServerLinks;
|
|
return;
|
|
}
|
|
}
|
|
/// `DialogScreen.WarningScreen`: the custom-screens note, a disconnect
|
|
/// button ("Custom screen rejected" is the shown reason) and Back.
|
|
pub(super) fn draw_dialog_warning(&mut self, batch: &mut HudBatch) {
|
|
let atlas = &self.gui.atlas;
|
|
let (w, h) = (batch.width, batch.height);
|
|
ui::menu_background(batch, atlas, 0.0, 0.0, w, h, true);
|
|
let layout = dialog_warning_layout(atlas, (w, h));
|
|
for (line, x, y) in &layout.lines {
|
|
batch.text_styled(atlas, line, *x, *y, u32::MAX, true);
|
|
}
|
|
let quit = if self.external_server() {
|
|
"menu.disconnect"
|
|
} else {
|
|
"menu.returnToMenu"
|
|
};
|
|
for ((x, y), key) in layout.buttons.into_iter().zip([quit, "gui.back"]) {
|
|
let hover = ui::hovered(self.cursor, x, y, 150.0, 20.0);
|
|
ui::button(
|
|
batch,
|
|
atlas,
|
|
x,
|
|
y,
|
|
150.0,
|
|
20.0,
|
|
&Text::translate(key, &[]),
|
|
true,
|
|
hover,
|
|
);
|
|
}
|
|
}
|
|
/// WarningScreen's answer: disconnect, or back to Server Links.
|
|
pub(super) fn dialog_warning_click(&mut self) -> Result<()> {
|
|
let (w, h) = self.gui_size();
|
|
let layout = dialog_warning_layout(&self.gui.atlas, (w, h));
|
|
for (i, (x, y)) in layout.buttons.iter().enumerate() {
|
|
if !ui::hovered(self.cursor, *x, *y, 150.0, 20.0) {
|
|
continue;
|
|
}
|
|
self.audio.play_button_click();
|
|
if i == 0 {
|
|
// DialogConnectionAccess.disconnect: leave with the custom
|
|
// screens' reason.
|
|
let reason = self.translate(
|
|
"menu.custom_screen_info.disconnect",
|
|
"Custom screen rejected",
|
|
);
|
|
self.leave_server(Some(reason))?;
|
|
} else {
|
|
self.screen = Screen::ServerLinks;
|
|
}
|
|
return Ok(());
|
|
}
|
|
Ok(())
|
|
}
|
|
}
|
|
|
|
/// A confirm screen's laid-out text (title, message, extra warning lines) and
|
|
/// button corners; the whole column centred (ConfirmScreen.init).
|
|
struct ConfirmLayout {
|
|
lines: Vec<(Text, f32, f32)>,
|
|
buttons: Vec<(f32, f32)>,
|
|
}
|
|
/// `ConfirmScreen.init`: title, message wrapped to `width - 50` (15 rows at
|
|
/// most), the extra lines, then a button row `spacing` 4 with `paddingTop` 16.
|
|
fn confirm_layout(
|
|
font: &horizon_client::font::Font,
|
|
(w, h): (f32, f32),
|
|
title: &Text,
|
|
message: &Text,
|
|
extra: &[Text],
|
|
button_widths: &[f32],
|
|
) -> ConfirmLayout {
|
|
let message: Vec<Text> = font
|
|
.split_lines(message, w - 50.0)
|
|
.into_iter()
|
|
.take(15)
|
|
.map(|(line, _)| line)
|
|
.collect();
|
|
// LinearLayout vertical spacing 8; the button row's children pad 16 on top.
|
|
let extra_h = 17.0 * extra.len() as f32;
|
|
let mh = 9.0 * message.len() as f32;
|
|
let total = 9.0 + 8.0 + mh + extra_h + 8.0 + 16.0 + 20.0;
|
|
let mut y = ((h - total) / 2.0).trunc();
|
|
let mut lines = Vec::new();
|
|
let mut push = |line: &Text, at: f32| {
|
|
let lw = font.width_text(line);
|
|
lines.push((line.clone(), ((w - lw) / 2.0).trunc(), at));
|
|
};
|
|
push(title, y);
|
|
y += 17.0;
|
|
for line in &message {
|
|
push(line, y);
|
|
y += 9.0;
|
|
}
|
|
for line in extra {
|
|
y += 8.0;
|
|
push(line, y);
|
|
y += 9.0;
|
|
}
|
|
let row_w: f32 = button_widths.iter().sum::<f32>() + 4.0 * (button_widths.len() - 1) as f32;
|
|
let by = y + 8.0 + 16.0;
|
|
let mut bx = ((w - row_w) / 2.0).trunc();
|
|
let buttons = button_widths
|
|
.iter()
|
|
.map(|bw| {
|
|
let p = (bx, by);
|
|
bx += bw + 4.0;
|
|
p
|
|
})
|
|
.collect();
|
|
ConfirmLayout { lines, buttons }
|
|
}
|
|
fn confirm_link_layout(
|
|
atlas: &horizon_client::hud::HudAtlas,
|
|
size: (f32, f32),
|
|
url: &str,
|
|
) -> ConfirmLayout {
|
|
// ConfirmLinkScreen (untrusted): `chat.link.confirm`, the link as the
|
|
// message, `chat.link.warning` in its red (0xFFCCCC).
|
|
confirm_layout(
|
|
&atlas.font,
|
|
size,
|
|
&Text::translate("chat.link.confirm", &[]),
|
|
&Text::literal(url.to_owned()),
|
|
&[Text::translate("chat.link.warning", &[]).with_color(0xFFCCCC)],
|
|
&[100.0; 3],
|
|
)
|
|
}
|
|
fn dialog_warning_layout(atlas: &horizon_client::hud::HudAtlas, size: (f32, f32)) -> ConfirmLayout {
|
|
confirm_layout(
|
|
&atlas.font,
|
|
size,
|
|
&Text::translate("menu.custom_screen_info.title", &[]),
|
|
&Text::translate("menu.custom_screen_info.contents", &[]),
|
|
&[],
|
|
&[150.0; 2],
|
|
)
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod tests {
|
|
use super::*;
|
|
|
|
#[test]
|
|
fn untrusted_uris_are_http_or_https_with_a_scheme() {
|
|
for ok in [
|
|
"https://example.net/x",
|
|
"http://example.net",
|
|
"HTTPS://EXAMPLE.NET",
|
|
] {
|
|
assert!(valid_untrusted_uri(ok), "{ok}");
|
|
}
|
|
for bad in [
|
|
"example.net/no-scheme",
|
|
"ftp://example.net",
|
|
"file:///etc/passwd",
|
|
"javascript:alert(1)",
|
|
"https://exa mple.net",
|
|
"://example.net",
|
|
"",
|
|
] {
|
|
assert!(!valid_untrusted_uri(bad), "{bad}");
|
|
}
|
|
}
|
|
}
|