bauiv1lib.gather.manualtab

   1# Released under the MIT License. See LICENSE for details.
   2#
   3"""Defines the manual tab in the gather UI."""
   4# pylint: disable=too-many-lines
   5
   6from __future__ import annotations
   7
   8import logging
   9from enum import Enum
  10from threading import Thread
  11from dataclasses import dataclass
  12from typing import TYPE_CHECKING, cast, override
  13from bauiv1lib.gather import GatherTab
  14
  15import bauiv1 as bui
  16import bascenev1 as bs
  17
  18if TYPE_CHECKING:
  19    from typing import Any, Callable
  20
  21    from bauiv1lib.gather import GatherWindow
  22
  23
  24def _safe_set_text(
  25    txt: bui.Widget | None, val: str | bui.Lstr, success: bool = True
  26) -> None:
  27    if txt:
  28        bui.textwidget(
  29            edit=txt, text=val, color=(0, 1, 0) if success else (1, 1, 0)
  30        )
  31
  32
  33class _HostLookupThread(Thread):
  34    """Thread to fetch an addr."""
  35
  36    def __init__(
  37        self, name: str, port: int, call: Callable[[str | None, int], Any]
  38    ):
  39        super().__init__()
  40        self._name = name
  41        self._port = port
  42        self._call = call
  43
  44    @override
  45    def run(self) -> None:
  46        result: str | None
  47        try:
  48            import socket
  49
  50            result = [
  51                item[-1][0]
  52                for item in socket.getaddrinfo(self.name, self._port)
  53            ][0]
  54        except Exception:
  55            result = None
  56        bui.pushcall(
  57            lambda: self._call(result, self._port), from_other_thread=True
  58        )
  59
  60
  61class SubTabType(Enum):
  62    """Available sub-tabs."""
  63
  64    JOIN_BY_ADDRESS = 'join_by_address'
  65    FAVORITES = 'favorites'
  66
  67
  68@dataclass
  69class State:
  70    """State saved/restored only while the app is running."""
  71
  72    sub_tab: SubTabType = SubTabType.JOIN_BY_ADDRESS
  73
  74
  75class ManualGatherTab(GatherTab):
  76    """The manual tab in the gather UI"""
  77
  78    def __init__(self, window: GatherWindow) -> None:
  79        super().__init__(window)
  80        self._check_button: bui.Widget | None = None
  81        self._doing_access_check: bool | None = None
  82        self._access_check_count: int | None = None
  83        self._sub_tab: SubTabType = SubTabType.JOIN_BY_ADDRESS
  84        self._t_addr: bui.Widget | None = None
  85        self._t_accessible: bui.Widget | None = None
  86        self._t_accessible_extra: bui.Widget | None = None
  87        self._access_check_timer: bui.AppTimer | None = None
  88        self._checking_state_text: bui.Widget | None = None
  89        self._container: bui.Widget | None = None
  90        self._join_by_address_text: bui.Widget | None = None
  91        self._favorites_text: bui.Widget | None = None
  92        self._width: float | None = None
  93        self._height: float | None = None
  94        self._scroll_width: float | None = None
  95        self._scroll_height: float | None = None
  96        self._favorites_scroll_width: int | None = None
  97        self._favorites_connect_button: bui.Widget | None = None
  98        self._scrollwidget: bui.Widget | None = None
  99        self._columnwidget: bui.Widget | None = None
 100        self._favorite_selected: str | None = None
 101        self._favorite_edit_window: bui.Widget | None = None
 102        self._party_edit_name_text: bui.Widget | None = None
 103        self._party_edit_addr_text: bui.Widget | None = None
 104        self._party_edit_port_text: bui.Widget | None = None
 105        self._no_parties_added_text: bui.Widget | None = None
 106
 107    @override
 108    def on_activate(
 109        self,
 110        parent_widget: bui.Widget,
 111        tab_button: bui.Widget,
 112        region_width: float,
 113        region_height: float,
 114        region_left: float,
 115        region_bottom: float,
 116    ) -> bui.Widget:
 117        c_width = region_width
 118        c_height = region_height - 20
 119
 120        self._container = bui.containerwidget(
 121            parent=parent_widget,
 122            position=(
 123                region_left,
 124                region_bottom + (region_height - c_height) * 0.5,
 125            ),
 126            size=(c_width, c_height),
 127            background=False,
 128            selection_loops_to_parent=True,
 129        )
 130        v = c_height - 30
 131        self._join_by_address_text = bui.textwidget(
 132            parent=self._container,
 133            position=(c_width * 0.5 - 245, v - 13),
 134            color=(0.6, 1.0, 0.6),
 135            scale=1.3,
 136            size=(200, 30),
 137            maxwidth=250,
 138            h_align='center',
 139            v_align='center',
 140            click_activate=True,
 141            selectable=True,
 142            autoselect=True,
 143            on_activate_call=lambda: self._set_sub_tab(
 144                SubTabType.JOIN_BY_ADDRESS,
 145                region_width,
 146                region_height,
 147                playsound=True,
 148            ),
 149            text=bui.Lstr(resource='gatherWindow.manualJoinSectionText'),
 150            glow_type='uniform',
 151        )
 152        self._favorites_text = bui.textwidget(
 153            parent=self._container,
 154            position=(c_width * 0.5 + 45, v - 13),
 155            color=(0.6, 1.0, 0.6),
 156            scale=1.3,
 157            size=(200, 30),
 158            maxwidth=250,
 159            h_align='center',
 160            v_align='center',
 161            click_activate=True,
 162            selectable=True,
 163            autoselect=True,
 164            on_activate_call=lambda: self._set_sub_tab(
 165                SubTabType.FAVORITES,
 166                region_width,
 167                region_height,
 168                playsound=True,
 169            ),
 170            text=bui.Lstr(resource='gatherWindow.favoritesText'),
 171            glow_type='uniform',
 172        )
 173        bui.widget(edit=self._join_by_address_text, up_widget=tab_button)
 174        bui.widget(
 175            edit=self._favorites_text,
 176            left_widget=self._join_by_address_text,
 177            up_widget=tab_button,
 178        )
 179        bui.widget(edit=tab_button, down_widget=self._favorites_text)
 180        bui.widget(
 181            edit=self._join_by_address_text, right_widget=self._favorites_text
 182        )
 183        self._set_sub_tab(self._sub_tab, region_width, region_height)
 184
 185        return self._container
 186
 187    @override
 188    def save_state(self) -> None:
 189        assert bui.app.classic is not None
 190        bui.app.ui_v1.window_states[type(self)] = State(sub_tab=self._sub_tab)
 191
 192    @override
 193    def restore_state(self) -> None:
 194        assert bui.app.classic is not None
 195        state = bui.app.ui_v1.window_states.get(type(self))
 196        if state is None:
 197            state = State()
 198        assert isinstance(state, State)
 199        self._sub_tab = state.sub_tab
 200
 201    def _set_sub_tab(
 202        self,
 203        value: SubTabType,
 204        region_width: float,
 205        region_height: float,
 206        playsound: bool = False,
 207    ) -> None:
 208        assert self._container
 209        if playsound:
 210            bui.getsound('click01').play()
 211
 212        self._sub_tab = value
 213        active_color = (0.6, 1.0, 0.6)
 214        inactive_color = (0.5, 0.4, 0.5)
 215        bui.textwidget(
 216            edit=self._join_by_address_text,
 217            color=(
 218                active_color
 219                if value is SubTabType.JOIN_BY_ADDRESS
 220                else inactive_color
 221            ),
 222        )
 223        bui.textwidget(
 224            edit=self._favorites_text,
 225            color=(
 226                active_color
 227                if value is SubTabType.FAVORITES
 228                else inactive_color
 229            ),
 230        )
 231
 232        # Clear anything existing in the old sub-tab.
 233        for widget in self._container.get_children():
 234            if widget and widget not in {
 235                self._favorites_text,
 236                self._join_by_address_text,
 237            }:
 238                widget.delete()
 239
 240        if value is SubTabType.JOIN_BY_ADDRESS:
 241            self._build_join_by_address_tab(region_width, region_height)
 242
 243        if value is SubTabType.FAVORITES:
 244            self._build_favorites_tab(region_width, region_height)
 245
 246    # The old manual tab
 247    def _build_join_by_address_tab(
 248        self, region_width: float, region_height: float
 249    ) -> None:
 250        c_width = region_width
 251        c_height = region_height - 20
 252        last_addr = bui.app.config.get('Last Manual Party Connect Address', '')
 253        last_port = bui.app.config.get('Last Manual Party Connect Port', 43210)
 254        v = c_height - 70
 255        v -= 70
 256        bui.textwidget(
 257            parent=self._container,
 258            position=(c_width * 0.5 - 260 - 50, v),
 259            color=(0.6, 1.0, 0.6),
 260            scale=1.0,
 261            size=(0, 0),
 262            maxwidth=130,
 263            h_align='right',
 264            v_align='center',
 265            text=bui.Lstr(resource='gatherWindow.' 'manualAddressText'),
 266        )
 267        txt = bui.textwidget(
 268            parent=self._container,
 269            editable=True,
 270            description=bui.Lstr(resource='gatherWindow.' 'manualAddressText'),
 271            position=(c_width * 0.5 - 240 - 50, v - 30),
 272            text=last_addr,
 273            autoselect=True,
 274            v_align='center',
 275            scale=1.0,
 276            maxwidth=380,
 277            size=(420, 60),
 278        )
 279        assert self._join_by_address_text is not None
 280        bui.widget(edit=self._join_by_address_text, down_widget=txt)
 281        assert self._favorites_text is not None
 282        bui.widget(edit=self._favorites_text, down_widget=txt)
 283        bui.textwidget(
 284            parent=self._container,
 285            position=(c_width * 0.5 - 260 + 490, v),
 286            color=(0.6, 1.0, 0.6),
 287            scale=1.0,
 288            size=(0, 0),
 289            maxwidth=80,
 290            h_align='right',
 291            v_align='center',
 292            text=bui.Lstr(resource='gatherWindow.' 'portText'),
 293        )
 294        txt2 = bui.textwidget(
 295            parent=self._container,
 296            editable=True,
 297            description=bui.Lstr(resource='gatherWindow.' 'portText'),
 298            text=str(last_port),
 299            autoselect=True,
 300            max_chars=5,
 301            position=(c_width * 0.5 - 240 + 490, v - 30),
 302            v_align='center',
 303            scale=1.0,
 304            size=(170, 60),
 305        )
 306
 307        v -= 110
 308
 309        btn = bui.buttonwidget(
 310            parent=self._container,
 311            size=(300, 70),
 312            label=bui.Lstr(resource='gatherWindow.' 'manualConnectText'),
 313            position=(c_width * 0.5 - 300, v),
 314            autoselect=True,
 315            on_activate_call=bui.Call(self._connect, txt, txt2),
 316        )
 317        savebutton = bui.buttonwidget(
 318            parent=self._container,
 319            size=(300, 70),
 320            label=bui.Lstr(resource='gatherWindow.favoritesSaveText'),
 321            position=(c_width * 0.5 - 240 + 490 - 200, v),
 322            autoselect=True,
 323            on_activate_call=bui.Call(self._save_server, txt, txt2),
 324        )
 325        bui.widget(edit=btn, right_widget=savebutton)
 326        bui.widget(edit=savebutton, left_widget=btn, up_widget=txt2)
 327        bui.textwidget(edit=txt, on_return_press_call=btn.activate)
 328        bui.textwidget(edit=txt2, on_return_press_call=btn.activate)
 329        v -= 45
 330
 331        self._check_button = bui.textwidget(
 332            parent=self._container,
 333            size=(250, 60),
 334            text=bui.Lstr(resource='gatherWindow.showMyAddressText'),
 335            v_align='center',
 336            h_align='center',
 337            click_activate=True,
 338            position=(c_width * 0.5 - 125, v - 30),
 339            autoselect=True,
 340            color=(0.5, 0.9, 0.5),
 341            scale=0.8,
 342            selectable=True,
 343            on_activate_call=bui.Call(
 344                self._on_show_my_address_button_press,
 345                v,
 346                self._container,
 347                c_width,
 348            ),
 349            glow_type='uniform',
 350        )
 351        bui.widget(edit=self._check_button, up_widget=btn)
 352
 353    # Tab containing saved favorite addresses
 354    def _build_favorites_tab(
 355        self, region_width: float, region_height: float
 356    ) -> None:
 357        c_height = region_height - 20
 358        v = c_height - 35 - 25 - 30
 359
 360        assert bui.app.classic is not None
 361        uiscale = bui.app.ui_v1.uiscale
 362        # self._width = 1240 if uiscale is bui.UIScale.SMALL else 1040
 363        self._width = region_width
 364        x_inset = 100 if uiscale is bui.UIScale.SMALL else 0
 365        self._height = (
 366            578
 367            if uiscale is bui.UIScale.SMALL
 368            else 670 if uiscale is bui.UIScale.MEDIUM else 800
 369        )
 370
 371        self._scroll_width = self._width - 130 + 2 * x_inset
 372        self._scroll_height = self._height - 180
 373        x_inset = 100 if uiscale is bui.UIScale.SMALL else 0
 374
 375        c_height = self._scroll_height - 20
 376        sub_scroll_height = c_height - 63
 377        self._favorites_scroll_width = sub_scroll_width = (
 378            680 if uiscale is bui.UIScale.SMALL else 640
 379        )
 380
 381        v = c_height - 30
 382
 383        b_width = 140 if uiscale is bui.UIScale.SMALL else 178
 384        b_height = (
 385            107
 386            if uiscale is bui.UIScale.SMALL
 387            else 142 if uiscale is bui.UIScale.MEDIUM else 190
 388        )
 389        b_space_extra = (
 390            0
 391            if uiscale is bui.UIScale.SMALL
 392            else -2 if uiscale is bui.UIScale.MEDIUM else -5
 393        )
 394
 395        btnv = (
 396            c_height
 397            - (
 398                48
 399                if uiscale is bui.UIScale.SMALL
 400                else 45 if uiscale is bui.UIScale.MEDIUM else 40
 401            )
 402            - b_height
 403        )
 404
 405        self._favorites_connect_button = btn1 = bui.buttonwidget(
 406            parent=self._container,
 407            size=(b_width, b_height),
 408            position=(140 if uiscale is bui.UIScale.SMALL else 40, btnv),
 409            button_type='square',
 410            color=(0.6, 0.53, 0.63),
 411            textcolor=(0.75, 0.7, 0.8),
 412            on_activate_call=self._on_favorites_connect_press,
 413            text_scale=1.0 if uiscale is bui.UIScale.SMALL else 1.2,
 414            label=bui.Lstr(resource='gatherWindow.manualConnectText'),
 415            autoselect=True,
 416        )
 417        if uiscale is bui.UIScale.SMALL:
 418            bui.widget(
 419                edit=btn1,
 420                left_widget=bui.get_special_widget('back_button'),
 421            )
 422        btnv -= b_height + b_space_extra
 423        bui.buttonwidget(
 424            parent=self._container,
 425            size=(b_width, b_height),
 426            position=(140 if uiscale is bui.UIScale.SMALL else 40, btnv),
 427            button_type='square',
 428            color=(0.6, 0.53, 0.63),
 429            textcolor=(0.75, 0.7, 0.8),
 430            on_activate_call=self._on_favorites_edit_press,
 431            text_scale=1.0 if uiscale is bui.UIScale.SMALL else 1.2,
 432            label=bui.Lstr(resource='editText'),
 433            autoselect=True,
 434        )
 435        btnv -= b_height + b_space_extra
 436        bui.buttonwidget(
 437            parent=self._container,
 438            size=(b_width, b_height),
 439            position=(140 if uiscale is bui.UIScale.SMALL else 40, btnv),
 440            button_type='square',
 441            color=(0.6, 0.53, 0.63),
 442            textcolor=(0.75, 0.7, 0.8),
 443            on_activate_call=self._on_favorite_delete_press,
 444            text_scale=1.0 if uiscale is bui.UIScale.SMALL else 1.2,
 445            label=bui.Lstr(resource='deleteText'),
 446            autoselect=True,
 447        )
 448
 449        v -= sub_scroll_height + 23
 450        self._scrollwidget = scrlw = bui.scrollwidget(
 451            parent=self._container,
 452            position=(290 if uiscale is bui.UIScale.SMALL else 225, v),
 453            size=(sub_scroll_width, sub_scroll_height),
 454            claims_left_right=True,
 455        )
 456        bui.widget(
 457            edit=self._favorites_connect_button, right_widget=self._scrollwidget
 458        )
 459        self._columnwidget = bui.columnwidget(
 460            parent=scrlw,
 461            left_border=10,
 462            border=2,
 463            margin=0,
 464            claims_left_right=True,
 465        )
 466
 467        self._no_parties_added_text = bui.textwidget(
 468            parent=self._container,
 469            size=(0, 0),
 470            h_align='center',
 471            v_align='center',
 472            text='',
 473            color=(0.6, 0.6, 0.6),
 474            scale=1.2,
 475            position=(
 476                (
 477                    (240 if uiscale is bui.UIScale.SMALL else 225)
 478                    + sub_scroll_width * 0.5
 479                ),
 480                v + sub_scroll_height * 0.5,
 481            ),
 482            glow_type='uniform',
 483        )
 484
 485        self._favorite_selected = None
 486        self._refresh_favorites()
 487
 488    def _no_favorite_selected_error(self) -> None:
 489        bui.screenmessage(
 490            bui.Lstr(resource='nothingIsSelectedErrorText'), color=(1, 0, 0)
 491        )
 492        bui.getsound('error').play()
 493
 494    def _on_favorites_connect_press(self) -> None:
 495        if self._favorite_selected is None:
 496            self._no_favorite_selected_error()
 497
 498        else:
 499            config = bui.app.config['Saved Servers'][self._favorite_selected]
 500            _HostLookupThread(
 501                name=config['addr'],
 502                port=config['port'],
 503                call=bui.WeakCall(self._host_lookup_result),
 504            ).start()
 505
 506    def _on_favorites_edit_press(self) -> None:
 507        if self._favorite_selected is None:
 508            self._no_favorite_selected_error()
 509            return
 510
 511        c_width = 600
 512        c_height = 310
 513        assert bui.app.classic is not None
 514        uiscale = bui.app.ui_v1.uiscale
 515        self._favorite_edit_window = cnt = bui.containerwidget(
 516            scale=(
 517                1.8
 518                if uiscale is bui.UIScale.SMALL
 519                else 1.55 if uiscale is bui.UIScale.MEDIUM else 1.0
 520            ),
 521            size=(c_width, c_height),
 522            transition='in_scale',
 523        )
 524
 525        bui.textwidget(
 526            parent=cnt,
 527            size=(0, 0),
 528            h_align='center',
 529            v_align='center',
 530            text=bui.Lstr(resource='editText'),
 531            color=(0.6, 1.0, 0.6),
 532            maxwidth=c_width * 0.8,
 533            position=(c_width * 0.5, c_height - 60),
 534        )
 535
 536        bui.textwidget(
 537            parent=cnt,
 538            position=(c_width * 0.2 - 15, c_height - 120),
 539            color=(0.6, 1.0, 0.6),
 540            scale=1.0,
 541            size=(0, 0),
 542            maxwidth=60,
 543            h_align='right',
 544            v_align='center',
 545            text=bui.Lstr(resource='nameText'),
 546        )
 547
 548        self._party_edit_name_text = bui.textwidget(
 549            parent=cnt,
 550            size=(c_width * 0.7, 40),
 551            h_align='left',
 552            v_align='center',
 553            text=bui.app.config['Saved Servers'][self._favorite_selected][
 554                'name'
 555            ],
 556            editable=True,
 557            description=bui.Lstr(resource='nameText'),
 558            position=(c_width * 0.2, c_height - 140),
 559            autoselect=True,
 560            maxwidth=c_width * 0.6,
 561            max_chars=200,
 562        )
 563
 564        bui.textwidget(
 565            parent=cnt,
 566            position=(c_width * 0.2 - 15, c_height - 180),
 567            color=(0.6, 1.0, 0.6),
 568            scale=1.0,
 569            size=(0, 0),
 570            maxwidth=60,
 571            h_align='right',
 572            v_align='center',
 573            text=bui.Lstr(resource='gatherWindow.' 'manualAddressText'),
 574        )
 575
 576        self._party_edit_addr_text = bui.textwidget(
 577            parent=cnt,
 578            size=(c_width * 0.4, 40),
 579            h_align='left',
 580            v_align='center',
 581            text=bui.app.config['Saved Servers'][self._favorite_selected][
 582                'addr'
 583            ],
 584            editable=True,
 585            description=bui.Lstr(resource='gatherWindow.manualAddressText'),
 586            position=(c_width * 0.2, c_height - 200),
 587            autoselect=True,
 588            maxwidth=c_width * 0.35,
 589            max_chars=200,
 590        )
 591
 592        bui.textwidget(
 593            parent=cnt,
 594            position=(c_width * 0.7 - 10, c_height - 180),
 595            color=(0.6, 1.0, 0.6),
 596            scale=1.0,
 597            size=(0, 0),
 598            maxwidth=45,
 599            h_align='right',
 600            v_align='center',
 601            text=bui.Lstr(resource='gatherWindow.' 'portText'),
 602        )
 603
 604        self._party_edit_port_text = bui.textwidget(
 605            parent=cnt,
 606            size=(c_width * 0.2, 40),
 607            h_align='left',
 608            v_align='center',
 609            text=str(
 610                bui.app.config['Saved Servers'][self._favorite_selected]['port']
 611            ),
 612            editable=True,
 613            description=bui.Lstr(resource='gatherWindow.portText'),
 614            position=(c_width * 0.7, c_height - 200),
 615            autoselect=True,
 616            maxwidth=c_width * 0.2,
 617            max_chars=6,
 618        )
 619        cbtn = bui.buttonwidget(
 620            parent=cnt,
 621            label=bui.Lstr(resource='cancelText'),
 622            on_activate_call=bui.Call(
 623                lambda c: bui.containerwidget(edit=c, transition='out_scale'),
 624                cnt,
 625            ),
 626            size=(180, 60),
 627            position=(30, 30),
 628            autoselect=True,
 629        )
 630        okb = bui.buttonwidget(
 631            parent=cnt,
 632            label=bui.Lstr(resource='saveText'),
 633            size=(180, 60),
 634            position=(c_width - 230, 30),
 635            on_activate_call=bui.Call(self._edit_saved_party),
 636            autoselect=True,
 637        )
 638        bui.widget(edit=cbtn, right_widget=okb)
 639        bui.widget(edit=okb, left_widget=cbtn)
 640        bui.containerwidget(edit=cnt, cancel_button=cbtn, start_button=okb)
 641
 642    def _edit_saved_party(self) -> None:
 643        server = self._favorite_selected
 644        if self._favorite_selected is None:
 645            self._no_favorite_selected_error()
 646            return
 647        if not self._party_edit_name_text or not self._party_edit_addr_text:
 648            return
 649        new_name_raw = cast(
 650            str, bui.textwidget(query=self._party_edit_name_text)
 651        )
 652        new_addr_raw = cast(
 653            str, bui.textwidget(query=self._party_edit_addr_text)
 654        )
 655        new_port_raw = cast(
 656            str, bui.textwidget(query=self._party_edit_port_text)
 657        )
 658        bui.app.config['Saved Servers'][server]['name'] = new_name_raw
 659        bui.app.config['Saved Servers'][server]['addr'] = new_addr_raw
 660        try:
 661            bui.app.config['Saved Servers'][server]['port'] = int(new_port_raw)
 662        except ValueError:
 663            # Notify about incorrect port? I'm lazy; simply leave old value.
 664            pass
 665        bui.app.config.commit()
 666        bui.getsound('gunCocking').play()
 667        self._refresh_favorites()
 668
 669        bui.containerwidget(
 670            edit=self._favorite_edit_window, transition='out_scale'
 671        )
 672
 673    def _on_favorite_delete_press(self) -> None:
 674        from bauiv1lib import confirm
 675
 676        if self._favorite_selected is None:
 677            self._no_favorite_selected_error()
 678            return
 679        confirm.ConfirmWindow(
 680            bui.Lstr(
 681                resource='gameListWindow.deleteConfirmText',
 682                subs=[
 683                    (
 684                        '${LIST}',
 685                        bui.app.config['Saved Servers'][
 686                            self._favorite_selected
 687                        ]['name'],
 688                    )
 689                ],
 690            ),
 691            self._delete_saved_party,
 692            450,
 693            150,
 694        )
 695
 696    def _delete_saved_party(self) -> None:
 697        if self._favorite_selected is None:
 698            self._no_favorite_selected_error()
 699            return
 700        config = bui.app.config['Saved Servers']
 701        del config[self._favorite_selected]
 702        self._favorite_selected = None
 703        bui.app.config.commit()
 704        bui.getsound('shieldDown').play()
 705        self._refresh_favorites()
 706
 707    def _on_favorite_select(self, server: str) -> None:
 708        self._favorite_selected = server
 709
 710    def _refresh_favorites(self) -> None:
 711        assert self._columnwidget is not None
 712        for child in self._columnwidget.get_children():
 713            child.delete()
 714        t_scale = 1.6
 715
 716        config = bui.app.config
 717        if 'Saved Servers' in config:
 718            servers = config['Saved Servers']
 719
 720        else:
 721            servers = []
 722
 723        assert self._favorites_scroll_width is not None
 724        assert self._favorites_connect_button is not None
 725
 726        bui.textwidget(
 727            edit=self._no_parties_added_text,
 728            text='',
 729        )
 730        num_of_fav = 0
 731        for i, server in enumerate(servers):
 732            txt = bui.textwidget(
 733                parent=self._columnwidget,
 734                size=(self._favorites_scroll_width / t_scale, 30),
 735                selectable=True,
 736                color=(1.0, 1, 0.4),
 737                always_highlight=True,
 738                on_select_call=bui.Call(self._on_favorite_select, server),
 739                on_activate_call=self._favorites_connect_button.activate,
 740                text=(
 741                    config['Saved Servers'][server]['name']
 742                    if config['Saved Servers'][server]['name'] != ''
 743                    else config['Saved Servers'][server]['addr']
 744                    + ' '
 745                    + str(config['Saved Servers'][server]['port'])
 746                ),
 747                h_align='left',
 748                v_align='center',
 749                corner_scale=t_scale,
 750                maxwidth=(self._favorites_scroll_width / t_scale) * 0.93,
 751            )
 752            if i == 0:
 753                bui.widget(edit=txt, up_widget=self._favorites_text)
 754                self._favorite_selected = server
 755            bui.widget(
 756                edit=txt,
 757                left_widget=self._favorites_connect_button,
 758                right_widget=txt,
 759            )
 760            num_of_fav = num_of_fav + 1
 761
 762        # If there's no servers, allow selecting out of the scroll area
 763        bui.containerwidget(
 764            edit=self._scrollwidget,
 765            claims_left_right=bool(servers),
 766            claims_up_down=bool(servers),
 767        )
 768        assert self._scrollwidget is not None
 769        bui.widget(
 770            edit=self._scrollwidget,
 771            up_widget=self._favorites_text,
 772            left_widget=self._favorites_connect_button,
 773        )
 774        if num_of_fav == 0:
 775            bui.textwidget(
 776                edit=self._no_parties_added_text,
 777                text=bui.Lstr(resource='gatherWindow.noPartiesAddedText'),
 778            )
 779
 780    @override
 781    def on_deactivate(self) -> None:
 782        self._access_check_timer = None
 783
 784    def _connect(
 785        self, textwidget: bui.Widget, port_textwidget: bui.Widget
 786    ) -> None:
 787        addr = cast(str, bui.textwidget(query=textwidget))
 788        if addr == '':
 789            bui.screenmessage(
 790                bui.Lstr(resource='internal.invalidAddressErrorText'),
 791                color=(1, 0, 0),
 792            )
 793            bui.getsound('error').play()
 794            return
 795        try:
 796            port = int(cast(str, bui.textwidget(query=port_textwidget)))
 797        except ValueError:
 798            port = -1
 799        if port > 65535 or port < 0:
 800            bui.screenmessage(
 801                bui.Lstr(resource='internal.invalidPortErrorText'),
 802                color=(1, 0, 0),
 803            )
 804            bui.getsound('error').play()
 805            return
 806
 807        _HostLookupThread(
 808            name=addr, port=port, call=bui.WeakCall(self._host_lookup_result)
 809        ).start()
 810
 811    def _save_server(
 812        self, textwidget: bui.Widget, port_textwidget: bui.Widget
 813    ) -> None:
 814        addr = cast(str, bui.textwidget(query=textwidget))
 815        if addr == '':
 816            bui.screenmessage(
 817                bui.Lstr(resource='internal.invalidAddressErrorText'),
 818                color=(1, 0, 0),
 819            )
 820            bui.getsound('error').play()
 821            return
 822        try:
 823            port = int(cast(str, bui.textwidget(query=port_textwidget)))
 824        except ValueError:
 825            port = -1
 826        if port > 65535 or port < 0:
 827            bui.screenmessage(
 828                bui.Lstr(resource='internal.invalidPortErrorText'),
 829                color=(1, 0, 0),
 830            )
 831            bui.getsound('error').play()
 832            return
 833        config = bui.app.config
 834
 835        if addr:
 836            if not isinstance(config.get('Saved Servers'), dict):
 837                config['Saved Servers'] = {}
 838            config['Saved Servers'][f'{addr}@{port}'] = {
 839                'addr': addr,
 840                'port': port,
 841                'name': addr,
 842            }
 843            config.commit()
 844            bui.getsound('gunCocking').play()
 845            bui.screenmessage(
 846                bui.Lstr(
 847                    resource='addedToFavoritesText', subs=[('${NAME}', addr)]
 848                ),
 849                color=(0, 1, 0),
 850            )
 851        else:
 852            bui.screenmessage(
 853                bui.Lstr(resource='internal.invalidAddressErrorText'),
 854                color=(1, 0, 0),
 855            )
 856            bui.getsound('error').play()
 857
 858    def _host_lookup_result(
 859        self, resolved_address: str | None, port: int
 860    ) -> None:
 861        if resolved_address is None:
 862            bui.screenmessage(
 863                bui.Lstr(resource='internal.unableToResolveHostText'),
 864                color=(1, 0, 0),
 865            )
 866            bui.getsound('error').play()
 867        else:
 868            # Store for later.
 869            config = bui.app.config
 870            config['Last Manual Party Connect Address'] = resolved_address
 871            config['Last Manual Party Connect Port'] = port
 872            config.commit()
 873            bs.connect_to_party(resolved_address, port=port)
 874
 875    def _run_addr_fetch(self) -> None:
 876        try:
 877            # FIXME: Update this to work with IPv6.
 878            import socket
 879
 880            sock = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
 881            sock.connect(('8.8.8.8', 80))
 882            val = sock.getsockname()[0]
 883            sock.close()
 884            bui.pushcall(
 885                bui.Call(
 886                    _safe_set_text,
 887                    self._checking_state_text,
 888                    val,
 889                ),
 890                from_other_thread=True,
 891            )
 892        except Exception as exc:
 893            from efro.error import is_udp_communication_error
 894
 895            if is_udp_communication_error(exc):
 896                bui.pushcall(
 897                    bui.Call(
 898                        _safe_set_text,
 899                        self._checking_state_text,
 900                        bui.Lstr(resource='gatherWindow.' 'noConnectionText'),
 901                        False,
 902                    ),
 903                    from_other_thread=True,
 904                )
 905            else:
 906                bui.pushcall(
 907                    bui.Call(
 908                        _safe_set_text,
 909                        self._checking_state_text,
 910                        bui.Lstr(
 911                            resource='gatherWindow.' 'addressFetchErrorText'
 912                        ),
 913                        False,
 914                    ),
 915                    from_other_thread=True,
 916                )
 917                logging.exception('Error in AddrFetchThread.')
 918
 919    def _on_show_my_address_button_press(
 920        self, v2: float, container: bui.Widget | None, c_width: float
 921    ) -> None:
 922        if not container:
 923            return
 924
 925        tscl = 0.85
 926        tspc = 25
 927
 928        bui.getsound('swish').play()
 929        bui.textwidget(
 930            parent=container,
 931            position=(c_width * 0.5 - 10, v2),
 932            color=(0.6, 1.0, 0.6),
 933            scale=tscl,
 934            size=(0, 0),
 935            maxwidth=c_width * 0.45,
 936            flatness=1.0,
 937            h_align='right',
 938            v_align='center',
 939            text=bui.Lstr(
 940                resource='gatherWindow.' 'manualYourLocalAddressText'
 941            ),
 942        )
 943        self._checking_state_text = bui.textwidget(
 944            parent=container,
 945            position=(c_width * 0.5, v2),
 946            color=(0.5, 0.5, 0.5),
 947            scale=tscl,
 948            size=(0, 0),
 949            maxwidth=c_width * 0.45,
 950            flatness=1.0,
 951            h_align='left',
 952            v_align='center',
 953            text=bui.Lstr(resource='gatherWindow.' 'checkingText'),
 954        )
 955
 956        Thread(target=self._run_addr_fetch).start()
 957
 958        v2 -= tspc
 959        bui.textwidget(
 960            parent=container,
 961            position=(c_width * 0.5 - 10, v2),
 962            color=(0.6, 1.0, 0.6),
 963            scale=tscl,
 964            size=(0, 0),
 965            maxwidth=c_width * 0.45,
 966            flatness=1.0,
 967            h_align='right',
 968            v_align='center',
 969            text=bui.Lstr(
 970                resource='gatherWindow.' 'manualYourAddressFromInternetText'
 971            ),
 972        )
 973
 974        t_addr = bui.textwidget(
 975            parent=container,
 976            position=(c_width * 0.5, v2),
 977            color=(0.5, 0.5, 0.5),
 978            scale=tscl,
 979            size=(0, 0),
 980            maxwidth=c_width * 0.45,
 981            h_align='left',
 982            v_align='center',
 983            flatness=1.0,
 984            text=bui.Lstr(resource='gatherWindow.' 'checkingText'),
 985        )
 986        v2 -= tspc
 987        bui.textwidget(
 988            parent=container,
 989            position=(c_width * 0.5 - 10, v2),
 990            color=(0.6, 1.0, 0.6),
 991            scale=tscl,
 992            size=(0, 0),
 993            maxwidth=c_width * 0.45,
 994            flatness=1.0,
 995            h_align='right',
 996            v_align='center',
 997            text=bui.Lstr(
 998                resource='gatherWindow.' 'manualJoinableFromInternetText'
 999            ),
1000        )
1001
1002        t_accessible = bui.textwidget(
1003            parent=container,
1004            position=(c_width * 0.5, v2),
1005            color=(0.5, 0.5, 0.5),
1006            scale=tscl,
1007            size=(0, 0),
1008            maxwidth=c_width * 0.45,
1009            flatness=1.0,
1010            h_align='left',
1011            v_align='center',
1012            text=bui.Lstr(resource='gatherWindow.' 'checkingText'),
1013        )
1014        v2 -= 28
1015        t_accessible_extra = bui.textwidget(
1016            parent=container,
1017            position=(c_width * 0.5, v2),
1018            color=(1, 0.5, 0.2),
1019            scale=0.7,
1020            size=(0, 0),
1021            maxwidth=c_width * 0.9,
1022            flatness=1.0,
1023            h_align='center',
1024            v_align='center',
1025            text='',
1026        )
1027
1028        self._doing_access_check = False
1029        self._access_check_count = 0  # Cap our refreshes eventually.
1030        self._access_check_timer = bui.AppTimer(
1031            10.0,
1032            bui.WeakCall(
1033                self._access_check_update,
1034                t_addr,
1035                t_accessible,
1036                t_accessible_extra,
1037            ),
1038            repeat=True,
1039        )
1040
1041        # Kick initial off.
1042        self._access_check_update(t_addr, t_accessible, t_accessible_extra)
1043        if self._check_button:
1044            self._check_button.delete()
1045
1046    def _access_check_update(
1047        self,
1048        t_addr: bui.Widget,
1049        t_accessible: bui.Widget,
1050        t_accessible_extra: bui.Widget,
1051    ) -> None:
1052        assert bui.app.classic is not None
1053        # If we don't have an outstanding query, start one..
1054        assert self._doing_access_check is not None
1055        assert self._access_check_count is not None
1056        if not self._doing_access_check and self._access_check_count < 100:
1057            self._doing_access_check = True
1058            self._access_check_count += 1
1059            self._t_addr = t_addr
1060            self._t_accessible = t_accessible
1061            self._t_accessible_extra = t_accessible_extra
1062            bui.app.classic.master_server_v1_get(
1063                'bsAccessCheck',
1064                {'b': bui.app.env.engine_build_number},
1065                callback=bui.WeakCall(self._on_accessible_response),
1066            )
1067
1068    def _on_accessible_response(self, data: dict[str, Any] | None) -> None:
1069        t_addr = self._t_addr
1070        t_accessible = self._t_accessible
1071        t_accessible_extra = self._t_accessible_extra
1072        self._doing_access_check = False
1073        color_bad = (1, 1, 0)
1074        color_good = (0, 1, 0)
1075        if data is None or 'address' not in data or 'accessible' not in data:
1076            if t_addr:
1077                bui.textwidget(
1078                    edit=t_addr,
1079                    text=bui.Lstr(resource='gatherWindow.' 'noConnectionText'),
1080                    color=color_bad,
1081                )
1082            if t_accessible:
1083                bui.textwidget(
1084                    edit=t_accessible,
1085                    text=bui.Lstr(resource='gatherWindow.' 'noConnectionText'),
1086                    color=color_bad,
1087                )
1088            if t_accessible_extra:
1089                bui.textwidget(
1090                    edit=t_accessible_extra, text='', color=color_bad
1091                )
1092            return
1093        if t_addr:
1094            bui.textwidget(edit=t_addr, text=data['address'], color=color_good)
1095        if t_accessible:
1096            if data['accessible']:
1097                bui.textwidget(
1098                    edit=t_accessible,
1099                    text=bui.Lstr(
1100                        resource='gatherWindow.' 'manualJoinableYesText'
1101                    ),
1102                    color=color_good,
1103                )
1104                if t_accessible_extra:
1105                    bui.textwidget(
1106                        edit=t_accessible_extra, text='', color=color_good
1107                    )
1108            else:
1109                bui.textwidget(
1110                    edit=t_accessible,
1111                    text=bui.Lstr(
1112                        resource='gatherWindow.'
1113                        'manualJoinableNoWithAsteriskText'
1114                    ),
1115                    color=color_bad,
1116                )
1117                if t_accessible_extra:
1118                    bui.textwidget(
1119                        edit=t_accessible_extra,
1120                        text=bui.Lstr(
1121                            resource='gatherWindow.'
1122                            'manualRouterForwardingText',
1123                            subs=[
1124                                ('${PORT}', str(bs.get_game_port())),
1125                            ],
1126                        ),
1127                        color=color_bad,
1128                    )