bauiv1lib.watch

  1# Released under the MIT License. See LICENSE for details.
  2#
  3"""Provides UI functionality for watching replays."""
  4
  5from __future__ import annotations
  6
  7import os
  8import logging
  9from enum import Enum
 10from typing import TYPE_CHECKING, cast
 11
 12import bascenev1 as bs
 13import bauiv1 as bui
 14
 15if TYPE_CHECKING:
 16    from typing import Any
 17
 18
 19class WatchWindow(bui.Window):
 20    """Window for watching replays."""
 21
 22    class TabID(Enum):
 23        """Our available tab types."""
 24
 25        MY_REPLAYS = 'my_replays'
 26        TEST_TAB = 'test_tab'
 27
 28    def __init__(
 29        self,
 30        transition: str | None = 'in_right',
 31        origin_widget: bui.Widget | None = None,
 32    ):
 33        # pylint: disable=too-many-locals
 34        # pylint: disable=too-many-statements
 35        from bauiv1lib.tabs import TabRow
 36
 37        bui.set_analytics_screen('Watch Window')
 38        scale_origin: tuple[float, float] | None
 39        if origin_widget is not None:
 40            self._transition_out = 'out_scale'
 41            scale_origin = origin_widget.get_screen_space_center()
 42            transition = 'in_scale'
 43        else:
 44            self._transition_out = 'out_right'
 45            scale_origin = None
 46        assert bui.app.classic is not None
 47        bui.app.ui_v1.set_main_menu_location('Watch')
 48        self._tab_data: dict[str, Any] = {}
 49        self._my_replays_scroll_width: float | None = None
 50        self._my_replays_watch_replay_button: bui.Widget | None = None
 51        self._scrollwidget: bui.Widget | None = None
 52        self._columnwidget: bui.Widget | None = None
 53        self._my_replay_selected: str | None = None
 54        self._my_replays_rename_window: bui.Widget | None = None
 55        self._my_replay_rename_text: bui.Widget | None = None
 56        self._r = 'watchWindow'
 57        uiscale = bui.app.ui_v1.uiscale
 58        self._width = 1240 if uiscale is bui.UIScale.SMALL else 1040
 59        x_inset = 100 if uiscale is bui.UIScale.SMALL else 0
 60        self._height = (
 61            578
 62            if uiscale is bui.UIScale.SMALL
 63            else 670
 64            if uiscale is bui.UIScale.MEDIUM
 65            else 800
 66        )
 67        self._current_tab: WatchWindow.TabID | None = None
 68        extra_top = 20 if uiscale is bui.UIScale.SMALL else 0
 69
 70        super().__init__(
 71            root_widget=bui.containerwidget(
 72                size=(self._width, self._height + extra_top),
 73                transition=transition,
 74                toolbar_visibility='menu_minimal',
 75                scale_origin_stack_offset=scale_origin,
 76                scale=(
 77                    1.3
 78                    if uiscale is bui.UIScale.SMALL
 79                    else 0.97
 80                    if uiscale is bui.UIScale.MEDIUM
 81                    else 0.8
 82                ),
 83                stack_offset=(0, -10)
 84                if uiscale is bui.UIScale.SMALL
 85                else (0, 15)
 86                if uiscale is bui.UIScale.MEDIUM
 87                else (0, 0),
 88            )
 89        )
 90
 91        if uiscale is bui.UIScale.SMALL and bui.app.ui_v1.use_toolbars:
 92            bui.containerwidget(
 93                edit=self._root_widget, on_cancel_call=self._back
 94            )
 95            self._back_button = None
 96        else:
 97            self._back_button = btn = bui.buttonwidget(
 98                parent=self._root_widget,
 99                autoselect=True,
100                position=(70 + x_inset, self._height - 74),
101                size=(140, 60),
102                scale=1.1,
103                label=bui.Lstr(resource='backText'),
104                button_type='back',
105                on_activate_call=self._back,
106            )
107            bui.containerwidget(edit=self._root_widget, cancel_button=btn)
108            bui.buttonwidget(
109                edit=btn,
110                button_type='backSmall',
111                size=(60, 60),
112                label=bui.charstr(bui.SpecialChar.BACK),
113            )
114
115        bui.textwidget(
116            parent=self._root_widget,
117            position=(self._width * 0.5, self._height - 38),
118            size=(0, 0),
119            color=bui.app.ui_v1.title_color,
120            scale=1.5,
121            h_align='center',
122            v_align='center',
123            text=bui.Lstr(resource=self._r + '.titleText'),
124            maxwidth=400,
125        )
126
127        tabdefs = [
128            (
129                self.TabID.MY_REPLAYS,
130                bui.Lstr(resource=self._r + '.myReplaysText'),
131            ),
132            # (self.TabID.TEST_TAB, bui.Lstr(value='Testing')),
133        ]
134
135        scroll_buffer_h = 130 + 2 * x_inset
136        tab_buffer_h = 750 + 2 * x_inset
137
138        self._tab_row = TabRow(
139            self._root_widget,
140            tabdefs,
141            pos=(tab_buffer_h * 0.5, self._height - 130),
142            size=(self._width - tab_buffer_h, 50),
143            on_select_call=self._set_tab,
144        )
145
146        if bui.app.ui_v1.use_toolbars:
147            first_tab = self._tab_row.tabs[tabdefs[0][0]]
148            last_tab = self._tab_row.tabs[tabdefs[-1][0]]
149            bui.widget(
150                edit=last_tab.button,
151                right_widget=bui.get_special_widget('party_button'),
152            )
153            if uiscale is bui.UIScale.SMALL:
154                bbtn = bui.get_special_widget('back_button')
155                bui.widget(
156                    edit=first_tab.button, up_widget=bbtn, left_widget=bbtn
157                )
158
159        self._scroll_width = self._width - scroll_buffer_h
160        self._scroll_height = self._height - 180
161
162        # Not actually using a scroll widget anymore; just an image.
163        scroll_left = (self._width - self._scroll_width) * 0.5
164        scroll_bottom = self._height - self._scroll_height - 79 - 48
165        buffer_h = 10
166        buffer_v = 4
167        bui.imagewidget(
168            parent=self._root_widget,
169            position=(scroll_left - buffer_h, scroll_bottom - buffer_v),
170            size=(
171                self._scroll_width + 2 * buffer_h,
172                self._scroll_height + 2 * buffer_v,
173            ),
174            texture=bui.gettexture('scrollWidget'),
175            mesh_transparent=bui.getmesh('softEdgeOutside'),
176        )
177        self._tab_container: bui.Widget | None = None
178
179        self._restore_state()
180
181    def _set_tab(self, tab_id: TabID) -> None:
182        # pylint: disable=too-many-locals
183
184        if self._current_tab == tab_id:
185            return
186        self._current_tab = tab_id
187
188        # Preserve our current tab between runs.
189        cfg = bui.app.config
190        cfg['Watch Tab'] = tab_id.value
191        cfg.commit()
192
193        # Update tab colors based on which is selected.
194        # tabs.update_tab_button_colors(self._tab_buttons, tab)
195        self._tab_row.update_appearance(tab_id)
196
197        if self._tab_container:
198            self._tab_container.delete()
199        scroll_left = (self._width - self._scroll_width) * 0.5
200        scroll_bottom = self._height - self._scroll_height - 79 - 48
201
202        # A place where tabs can store data to get cleared when
203        # switching to a different tab
204        self._tab_data = {}
205
206        assert bui.app.classic is not None
207        uiscale = bui.app.ui_v1.uiscale
208        if tab_id is self.TabID.MY_REPLAYS:
209            c_width = self._scroll_width
210            c_height = self._scroll_height - 20
211            sub_scroll_height = c_height - 63
212            self._my_replays_scroll_width = sub_scroll_width = (
213                680 if uiscale is bui.UIScale.SMALL else 640
214            )
215
216            self._tab_container = cnt = bui.containerwidget(
217                parent=self._root_widget,
218                position=(
219                    scroll_left,
220                    scroll_bottom + (self._scroll_height - c_height) * 0.5,
221                ),
222                size=(c_width, c_height),
223                background=False,
224                selection_loops_to_parent=True,
225            )
226
227            v = c_height - 30
228            bui.textwidget(
229                parent=cnt,
230                position=(c_width * 0.5, v),
231                color=(0.6, 1.0, 0.6),
232                scale=0.7,
233                size=(0, 0),
234                maxwidth=c_width * 0.9,
235                h_align='center',
236                v_align='center',
237                text=bui.Lstr(
238                    resource='replayRenameWarningText',
239                    subs=[
240                        (
241                            '${REPLAY}',
242                            bui.Lstr(resource='replayNameDefaultText'),
243                        )
244                    ],
245                ),
246            )
247
248            b_width = 140 if uiscale is bui.UIScale.SMALL else 178
249            b_height = (
250                107
251                if uiscale is bui.UIScale.SMALL
252                else 142
253                if uiscale is bui.UIScale.MEDIUM
254                else 190
255            )
256            b_space_extra = (
257                0
258                if uiscale is bui.UIScale.SMALL
259                else -2
260                if uiscale is bui.UIScale.MEDIUM
261                else -5
262            )
263
264            b_color = (0.6, 0.53, 0.63)
265            b_textcolor = (0.75, 0.7, 0.8)
266            btnv = (
267                c_height
268                - (
269                    48
270                    if uiscale is bui.UIScale.SMALL
271                    else 45
272                    if uiscale is bui.UIScale.MEDIUM
273                    else 40
274                )
275                - b_height
276            )
277            btnh = 40 if uiscale is bui.UIScale.SMALL else 40
278            smlh = 190 if uiscale is bui.UIScale.SMALL else 225
279            tscl = 1.0 if uiscale is bui.UIScale.SMALL else 1.2
280            self._my_replays_watch_replay_button = btn1 = bui.buttonwidget(
281                parent=cnt,
282                size=(b_width, b_height),
283                position=(btnh, btnv),
284                button_type='square',
285                color=b_color,
286                textcolor=b_textcolor,
287                on_activate_call=self._on_my_replay_play_press,
288                text_scale=tscl,
289                label=bui.Lstr(resource=self._r + '.watchReplayButtonText'),
290                autoselect=True,
291            )
292            bui.widget(edit=btn1, up_widget=self._tab_row.tabs[tab_id].button)
293            assert bui.app.classic is not None
294            if uiscale is bui.UIScale.SMALL and bui.app.ui_v1.use_toolbars:
295                bui.widget(
296                    edit=btn1,
297                    left_widget=bui.get_special_widget('back_button'),
298                )
299            btnv -= b_height + b_space_extra
300            bui.buttonwidget(
301                parent=cnt,
302                size=(b_width, b_height),
303                position=(btnh, btnv),
304                button_type='square',
305                color=b_color,
306                textcolor=b_textcolor,
307                on_activate_call=self._on_my_replay_rename_press,
308                text_scale=tscl,
309                label=bui.Lstr(resource=self._r + '.renameReplayButtonText'),
310                autoselect=True,
311            )
312            btnv -= b_height + b_space_extra
313            bui.buttonwidget(
314                parent=cnt,
315                size=(b_width, b_height),
316                position=(btnh, btnv),
317                button_type='square',
318                color=b_color,
319                textcolor=b_textcolor,
320                on_activate_call=self._on_my_replay_delete_press,
321                text_scale=tscl,
322                label=bui.Lstr(resource=self._r + '.deleteReplayButtonText'),
323                autoselect=True,
324            )
325
326            v -= sub_scroll_height + 23
327            self._scrollwidget = scrlw = bui.scrollwidget(
328                parent=cnt,
329                position=(smlh, v),
330                size=(sub_scroll_width, sub_scroll_height),
331            )
332            bui.containerwidget(edit=cnt, selected_child=scrlw)
333            self._columnwidget = bui.columnwidget(
334                parent=scrlw, left_border=10, border=2, margin=0
335            )
336
337            bui.widget(
338                edit=scrlw,
339                autoselect=True,
340                left_widget=btn1,
341                up_widget=self._tab_row.tabs[tab_id].button,
342            )
343            bui.widget(
344                edit=self._tab_row.tabs[tab_id].button, down_widget=scrlw
345            )
346
347            self._my_replay_selected = None
348            self._refresh_my_replays()
349
350    def _no_replay_selected_error(self) -> None:
351        bui.screenmessage(
352            bui.Lstr(resource=self._r + '.noReplaySelectedErrorText'),
353            color=(1, 0, 0),
354        )
355        bui.getsound('error').play()
356
357    def _on_my_replay_play_press(self) -> None:
358        if self._my_replay_selected is None:
359            self._no_replay_selected_error()
360            return
361        bui.increment_analytics_count('Replay watch')
362
363        def do_it() -> None:
364            try:
365                # Reset to normal speed.
366                bs.set_replay_speed_exponent(0)
367                bui.fade_screen(True)
368                assert self._my_replay_selected is not None
369                bs.new_replay_session(
370                    bui.get_replays_dir() + '/' + self._my_replay_selected
371                )
372            except Exception:
373                logging.exception('Error running replay session.')
374
375                # Drop back into a fresh main menu session
376                # in case we half-launched or something.
377                from bascenev1lib import mainmenu
378
379                bs.new_host_session(mainmenu.MainMenuSession)
380
381        bui.fade_screen(False, endcall=bui.Call(bui.pushcall, do_it))
382        bui.containerwidget(edit=self._root_widget, transition='out_left')
383
384    def _on_my_replay_rename_press(self) -> None:
385        if self._my_replay_selected is None:
386            self._no_replay_selected_error()
387            return
388        c_width = 600
389        c_height = 250
390        assert bui.app.classic is not None
391        uiscale = bui.app.ui_v1.uiscale
392        self._my_replays_rename_window = cnt = bui.containerwidget(
393            scale=(
394                1.8
395                if uiscale is bui.UIScale.SMALL
396                else 1.55
397                if uiscale is bui.UIScale.MEDIUM
398                else 1.0
399            ),
400            size=(c_width, c_height),
401            transition='in_scale',
402        )
403        dname = self._get_replay_display_name(self._my_replay_selected)
404        bui.textwidget(
405            parent=cnt,
406            size=(0, 0),
407            h_align='center',
408            v_align='center',
409            text=bui.Lstr(
410                resource=self._r + '.renameReplayText',
411                subs=[('${REPLAY}', dname)],
412            ),
413            maxwidth=c_width * 0.8,
414            position=(c_width * 0.5, c_height - 60),
415        )
416        self._my_replay_rename_text = txt = bui.textwidget(
417            parent=cnt,
418            size=(c_width * 0.8, 40),
419            h_align='left',
420            v_align='center',
421            text=dname,
422            editable=True,
423            description=bui.Lstr(resource=self._r + '.replayNameText'),
424            position=(c_width * 0.1, c_height - 140),
425            autoselect=True,
426            maxwidth=c_width * 0.7,
427            max_chars=200,
428        )
429        cbtn = bui.buttonwidget(
430            parent=cnt,
431            label=bui.Lstr(resource='cancelText'),
432            on_activate_call=bui.Call(
433                lambda c: bui.containerwidget(edit=c, transition='out_scale'),
434                cnt,
435            ),
436            size=(180, 60),
437            position=(30, 30),
438            autoselect=True,
439        )
440        okb = bui.buttonwidget(
441            parent=cnt,
442            label=bui.Lstr(resource=self._r + '.renameText'),
443            size=(180, 60),
444            position=(c_width - 230, 30),
445            on_activate_call=bui.Call(
446                self._rename_my_replay, self._my_replay_selected
447            ),
448            autoselect=True,
449        )
450        bui.widget(edit=cbtn, right_widget=okb)
451        bui.widget(edit=okb, left_widget=cbtn)
452        bui.textwidget(edit=txt, on_return_press_call=okb.activate)
453        bui.containerwidget(edit=cnt, cancel_button=cbtn, start_button=okb)
454
455    def _rename_my_replay(self, replay: str) -> None:
456        new_name = None
457        try:
458            if not self._my_replay_rename_text:
459                return
460            new_name_raw = cast(
461                str, bui.textwidget(query=self._my_replay_rename_text)
462            )
463            new_name = new_name_raw + '.brp'
464
465            # Ignore attempts to change it to what it already is
466            # (or what it looks like to the user).
467            if (
468                replay != new_name
469                and self._get_replay_display_name(replay) != new_name_raw
470            ):
471                old_name_full = (bui.get_replays_dir() + '/' + replay).encode(
472                    'utf-8'
473                )
474                new_name_full = (bui.get_replays_dir() + '/' + new_name).encode(
475                    'utf-8'
476                )
477                # False alarm; bui.textwidget can return non-None val.
478                # pylint: disable=unsupported-membership-test
479                if os.path.exists(new_name_full):
480                    bui.getsound('error').play()
481                    bui.screenmessage(
482                        bui.Lstr(
483                            resource=self._r
484                            + '.replayRenameErrorAlreadyExistsText'
485                        ),
486                        color=(1, 0, 0),
487                    )
488                elif any(char in new_name_raw for char in ['/', '\\', ':']):
489                    bui.getsound('error').play()
490                    bui.screenmessage(
491                        bui.Lstr(
492                            resource=self._r + '.replayRenameErrorInvalidName'
493                        ),
494                        color=(1, 0, 0),
495                    )
496                else:
497                    bui.increment_analytics_count('Replay rename')
498                    os.rename(old_name_full, new_name_full)
499                    self._refresh_my_replays()
500                    bui.getsound('gunCocking').play()
501        except Exception:
502            logging.exception(
503                "Error renaming replay '%s' to '%s'.", replay, new_name
504            )
505            bui.getsound('error').play()
506            bui.screenmessage(
507                bui.Lstr(resource=self._r + '.replayRenameErrorText'),
508                color=(1, 0, 0),
509            )
510
511        bui.containerwidget(
512            edit=self._my_replays_rename_window, transition='out_scale'
513        )
514
515    def _on_my_replay_delete_press(self) -> None:
516        from bauiv1lib import confirm
517
518        if self._my_replay_selected is None:
519            self._no_replay_selected_error()
520            return
521        confirm.ConfirmWindow(
522            bui.Lstr(
523                resource=self._r + '.deleteConfirmText',
524                subs=[
525                    (
526                        '${REPLAY}',
527                        self._get_replay_display_name(self._my_replay_selected),
528                    )
529                ],
530            ),
531            bui.Call(self._delete_replay, self._my_replay_selected),
532            450,
533            150,
534        )
535
536    def _get_replay_display_name(self, replay: str) -> str:
537        if replay.endswith('.brp'):
538            replay = replay[:-4]
539        if replay == '__lastReplay':
540            return bui.Lstr(resource='replayNameDefaultText').evaluate()
541        return replay
542
543    def _delete_replay(self, replay: str) -> None:
544        try:
545            bui.increment_analytics_count('Replay delete')
546            os.remove((bui.get_replays_dir() + '/' + replay).encode('utf-8'))
547            self._refresh_my_replays()
548            bui.getsound('shieldDown').play()
549            if replay == self._my_replay_selected:
550                self._my_replay_selected = None
551        except Exception:
552            logging.exception("Error deleting replay '%s'.", replay)
553            bui.getsound('error').play()
554            bui.screenmessage(
555                bui.Lstr(resource=self._r + '.replayDeleteErrorText'),
556                color=(1, 0, 0),
557            )
558
559    def _on_my_replay_select(self, replay: str) -> None:
560        self._my_replay_selected = replay
561
562    def _refresh_my_replays(self) -> None:
563        assert self._columnwidget is not None
564        for child in self._columnwidget.get_children():
565            child.delete()
566        t_scale = 1.6
567        try:
568            names = os.listdir(bui.get_replays_dir())
569
570            # Ignore random other files in there.
571            names = [n for n in names if n.endswith('.brp')]
572            names.sort(key=lambda x: x.lower())
573        except Exception:
574            logging.exception('Error listing replays dir.')
575            names = []
576
577        assert self._my_replays_scroll_width is not None
578        assert self._my_replays_watch_replay_button is not None
579        for i, name in enumerate(names):
580            txt = bui.textwidget(
581                parent=self._columnwidget,
582                size=(self._my_replays_scroll_width / t_scale, 30),
583                selectable=True,
584                color=(1.0, 1, 0.4)
585                if name == '__lastReplay.brp'
586                else (1, 1, 1),
587                always_highlight=True,
588                on_select_call=bui.Call(self._on_my_replay_select, name),
589                on_activate_call=self._my_replays_watch_replay_button.activate,
590                text=self._get_replay_display_name(name),
591                h_align='left',
592                v_align='center',
593                corner_scale=t_scale,
594                maxwidth=(self._my_replays_scroll_width / t_scale) * 0.93,
595            )
596            if i == 0:
597                bui.widget(
598                    edit=txt,
599                    up_widget=self._tab_row.tabs[self.TabID.MY_REPLAYS].button,
600                )
601
602    def _save_state(self) -> None:
603        try:
604            sel = self._root_widget.get_selected_child()
605            selected_tab_ids = [
606                tab_id
607                for tab_id, tab in self._tab_row.tabs.items()
608                if sel == tab.button
609            ]
610            if sel == self._back_button:
611                sel_name = 'Back'
612            elif selected_tab_ids:
613                assert len(selected_tab_ids) == 1
614                sel_name = f'Tab:{selected_tab_ids[0].value}'
615            elif sel == self._tab_container:
616                sel_name = 'TabContainer'
617            else:
618                raise ValueError(f'unrecognized selection {sel}')
619            assert bui.app.classic is not None
620            bui.app.ui_v1.window_states[type(self)] = {'sel_name': sel_name}
621        except Exception:
622            logging.exception('Error saving state for %s.', self)
623
624    def _restore_state(self) -> None:
625        from efro.util import enum_by_value
626
627        try:
628            sel: bui.Widget | None
629            assert bui.app.classic is not None
630            sel_name = bui.app.ui_v1.window_states.get(type(self), {}).get(
631                'sel_name'
632            )
633            assert isinstance(sel_name, (str, type(None)))
634            try:
635                current_tab = enum_by_value(
636                    self.TabID, bui.app.config.get('Watch Tab')
637                )
638            except ValueError:
639                current_tab = self.TabID.MY_REPLAYS
640            self._set_tab(current_tab)
641
642            if sel_name == 'Back':
643                sel = self._back_button
644            elif sel_name == 'TabContainer':
645                sel = self._tab_container
646            elif isinstance(sel_name, str) and sel_name.startswith('Tab:'):
647                try:
648                    sel_tab_id = enum_by_value(
649                        self.TabID, sel_name.split(':')[-1]
650                    )
651                except ValueError:
652                    sel_tab_id = self.TabID.MY_REPLAYS
653                sel = self._tab_row.tabs[sel_tab_id].button
654            else:
655                if self._tab_container is not None:
656                    sel = self._tab_container
657                else:
658                    sel = self._tab_row.tabs[current_tab].button
659            bui.containerwidget(edit=self._root_widget, selected_child=sel)
660        except Exception:
661            logging.exception('Error restoring state for %s.', self)
662
663    def _back(self) -> None:
664        from bauiv1lib.mainmenu import MainMenuWindow
665
666        self._save_state()
667        bui.containerwidget(
668            edit=self._root_widget, transition=self._transition_out
669        )
670        assert bui.app.classic is not None
671        bui.app.ui_v1.set_main_menu_window(
672            MainMenuWindow(transition='in_left').get_root_widget()
673        )