fractal/session/view/content/explore/

mod.rs

use adw::{prelude::*, subclass::prelude::*};
use gtk::{gio, glib, glib::clone, CompositeTemplate};
use tracing::error;

mod public_room_row;
mod search;
mod server;
mod server_list;
mod server_row;
mod servers_popover;

use self::{
    public_room_row::PublicRoomRow, search::ExploreSearch, server::ExploreServer,
    server_list::ExploreServerList, server_row::ExploreServerRow,
    servers_popover::ExploreServersPopover,
};
use crate::{
    components::LoadingRow,
    prelude::*,
    session::model::{RemoteRoom, Session},
    utils::{LoadingState, SingleItemListModel},
};

mod imp {
    use std::cell::OnceCell;

    use glib::subclass::InitializingObject;

    use super::*;

    #[derive(Debug, Default, CompositeTemplate, glib::Properties)]
    #[template(resource = "/org/gnome/Fractal/ui/session/view/content/explore/mod.ui")]
    #[properties(wrapper_type = super::Explore)]
    pub struct Explore {
        #[template_child]
        pub(super) header_bar: TemplateChild<adw::HeaderBar>,
        #[template_child]
        second_top_bar: TemplateChild<adw::Bin>,
        #[template_child]
        search_clamp: TemplateChild<adw::Clamp>,
        #[template_child]
        search_entry: TemplateChild<gtk::SearchEntry>,
        #[template_child]
        servers_button: TemplateChild<gtk::MenuButton>,
        #[template_child]
        servers_popover: TemplateChild<ExploreServersPopover>,
        #[template_child]
        stack: TemplateChild<gtk::Stack>,
        #[template_child]
        scrolled_window: TemplateChild<gtk::ScrolledWindow>,
        #[template_child]
        listview: TemplateChild<gtk::ListView>,
        /// The current session.
        #[property(get, set = Self::set_session, explicit_notify)]
        session: glib::WeakRef<Session>,
        /// The search of the view.
        search: ExploreSearch,
        /// The items added at the end of the list.
        end_items: OnceCell<SingleItemListModel>,
        /// The full list model.
        full_model: OnceCell<gio::ListStore>,
    }

    #[glib::object_subclass]
    impl ObjectSubclass for Explore {
        const NAME: &'static str = "ContentExplore";
        type Type = super::Explore;
        type ParentType = adw::BreakpointBin;

        fn class_init(klass: &mut Self::Class) {
            Self::bind_template(klass);
            Self::bind_template_callbacks(klass);

            klass.set_accessible_role(gtk::AccessibleRole::Group);
        }

        fn instance_init(obj: &InitializingObject<Self>) {
            obj.init_template();
        }
    }

    #[glib::derived_properties]
    impl ObjectImpl for Explore {
        fn constructed(&self) {
            self.parent_constructed();

            // Listen to a change of selected server.
            self.servers_popover.connect_selected_server_notify(clone!(
                #[weak(rename_to = imp)]
                self,
                move |_| {
                    imp.server_changed();
                }
            ));

            // Load more items when scrolling, if needed.
            let adj = self.scrolled_window.vadjustment();
            adj.connect_value_changed(clone!(
                #[weak(rename_to = imp)]
                self,
                move |adj| {
                    if adj.upper() - adj.value() < adj.page_size() * 2.0 {
                        imp.search.load_more();
                    }
                }
            ));

            // Set up the item factory for the GtkListView.
            let factory = gtk::SignalListItemFactory::new();
            factory.connect_bind(move |_, list_item| {
                let Some(list_item) = list_item.downcast_ref::<gtk::ListItem>() else {
                    error!("List item factory did not receive a list item: {list_item:?}");
                    return;
                };
                list_item.set_activatable(false);
                list_item.set_selectable(false);

                let Some(item) = list_item.item() else {
                    return;
                };

                if let Some(room) = item.downcast_ref::<RemoteRoom>() {
                    let public_room_row = list_item.child_or_default::<PublicRoomRow>();
                    public_room_row.set_room(room);
                } else if let Some(loading_row) = item.downcast_ref::<LoadingRow>() {
                    list_item.set_child(Some(loading_row));
                }
            });
            self.listview.set_factory(Some(&factory));

            let flattened_model = gtk::FlattenListModel::new(Some(self.full_model().clone()));
            self.listview
                .set_model(Some(&gtk::NoSelection::new(Some(flattened_model))));

            // Listen to changes in the search loading state.
            self.search.connect_loading_state_notify(clone!(
                #[weak(rename_to = imp)]
                self,
                move |_| {
                    imp.update_visible_child();
                }
            ));

            // Listen to changes in the results.
            self.search.list().connect_items_changed(clone!(
                #[weak(rename_to = imp)]
                self,
                move |_, _, _, _| {
                    imp.update_visible_child();
                }
            ));
        }
    }

    impl WidgetImpl for Explore {
        fn grab_focus(&self) -> bool {
            self.search_entry.grab_focus()
        }

        fn map(&self) {
            self.parent_map();
            self.trigger_search();
        }
    }

    impl BreakpointBinImpl for Explore {}

    #[gtk::template_callbacks]
    impl Explore {
        /// Set the current session.
        fn set_session(&self, session: Option<&Session>) {
            if self.session.upgrade().as_ref() == session {
                return;
            }

            self.session.set(session);

            self.trigger_search();
            self.obj().notify_session();
        }

        /// The items added at the end of the list.
        fn end_items(&self) -> &SingleItemListModel {
            self.end_items.get_or_init(|| {
                let model = SingleItemListModel::new(&LoadingRow::new());
                model.set_is_hidden(true);
                model
            })
        }

        /// The full list model.
        fn full_model(&self) -> &gio::ListStore {
            self.full_model.get_or_init(|| {
                let model = gio::ListStore::new::<gio::ListModel>();
                model.append(&self.search.list());
                model.append(self.end_items());
                model
            })
        }

        /// Update the header when the view is narrow.
        #[template_callback]
        fn switch_to_narrow_mode(&self) {
            if self
                .header_bar
                .title_widget()
                .is_some_and(|widget| widget == *self.servers_button)
            {
                // We are already in narrow mode, nothing to do.
                return;
            }

            // Unparent the children.
            self.header_bar.remove(&*self.search_clamp);
            self.header_bar.remove(&*self.servers_button);

            // In narrow mode, the servers button is in the header bar, and the search entry
            // is in the second top bar.
            self.header_bar
                .set_title_widget(Some(&*self.servers_button));
            self.second_top_bar.set_child(Some(&*self.search_clamp));
            self.second_top_bar.set_visible(true);
        }

        /// Update the header when the view is wide.
        #[template_callback]
        fn switch_to_wide_mode(&self) {
            if self
                .header_bar
                .title_widget()
                .is_some_and(|widget| widget == *self.search_clamp)
            {
                // We are already be in wide mode, nothing to do.
                return;
            }

            // Unparent the children.
            self.header_bar.remove(&*self.servers_button);
            self.second_top_bar.set_child(None::<&gtk::Widget>);
            self.second_top_bar.set_visible(false);

            // In wide mode, both widgets are in the header bar.
            self.header_bar.set_title_widget(Some(&*self.search_clamp));
            self.header_bar.pack_end(&*self.servers_button);
        }

        /// Update the visible child according to the current state.
        fn update_visible_child(&self) {
            let loading_state = self.search.loading_state();
            let is_empty = self.search.is_empty();

            // Create or remove the loading row, as needed.
            let show_loading_row = matches!(loading_state, LoadingState::Loading) && !is_empty;
            self.end_items().set_is_hidden(!show_loading_row);

            // Update the visible page.
            let page_name = match loading_state {
                LoadingState::Initial | LoadingState::Loading => {
                    if is_empty {
                        "loading"
                    } else {
                        "results"
                    }
                }
                LoadingState::Ready => {
                    if is_empty {
                        "empty"
                    } else {
                        "results"
                    }
                }
                LoadingState::Error => "error",
            };
            self.stack.set_visible_child_name(page_name);
        }

        /// Trigger a search with the current term.
        #[template_callback]
        pub(super) fn trigger_search(&self) {
            if !self.obj().is_mapped() {
                // Do not make a search if the view is not mapped.
                return;
            }

            let Some(session) = self.session.upgrade() else {
                return;
            };

            self.servers_popover.set_session(&session);

            let text = self.search_entry.text().into();
            let server = self
                .servers_popover
                .selected_server()
                .expect("a server should be selected");
            self.search.search(&session, Some(text), &server);
        }

        /// Handle when the selected server changed.
        fn server_changed(&self) {
            if let Some(server) = self.servers_popover.selected_server() {
                self.servers_button.set_label(&server.name());
                self.trigger_search();
            }
        }
    }
}

glib::wrapper! {
    /// A view to explore rooms in the public directory of homeservers.
    pub struct Explore(ObjectSubclass<imp::Explore>)
        @extends gtk::Widget, adw::BreakpointBin, @implements gtk::Accessible;
}

impl Explore {
    pub fn new(session: &Session) -> Self {
        glib::Object::builder().property("session", session).build()
    }

    /// The header bar of the explorer.
    pub(crate) fn header_bar(&self) -> &adw::HeaderBar {
        &self.imp().header_bar
    }
}