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