Loupe/src/widgets/image_view.rs

// image_view.rs
//
// Copyright 2020 Christopher Davis <christopherdavis@gnome.org>
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program.  If not, see <http://www.gnu.org/licenses/>.
//
// SPDX-License-Identifier: GPL-3.0-or-later

use crate::deps::*;

use adw::subclass::prelude::*;
use glib::clone;
use gtk::prelude::*;
use gtk::subclass::prelude::*;
use gtk::CompositeTemplate;

use anyhow::Context;
use ashpd::desktop::wallpaper;
use ashpd::WindowIdentifier;
use once_cell::sync::Lazy;
use std::cell::{Cell, RefCell};

use crate::util;
use crate::widgets::LpImage;

mod imp {
    use super::*;

    #[derive(Debug, Default, CompositeTemplate)]
    #[template(resource = "/org/gnome/Loupe/gtk/image_view.ui")]
    pub struct LpImageView {
        #[template_child]
        pub picture: TemplateChild<LpImage>,
        #[template_child]
        pub controls: TemplateChild<gtk::Box>,
        #[template_child]
        pub popover: TemplateChild<gtk::PopoverMenu>,
        #[template_child]
        pub click_gesture: TemplateChild<gtk::GestureClick>,
        #[template_child]
        pub press_gesture: TemplateChild<gtk::GestureLongPress>,

        // RefCell<T> allows for interior mutability of non-primitive types.
        pub menu_model: RefCell<Option<gio::MenuModel>>,
        pub popover_menu_model: RefCell<Option<gio::MenuModel>>,

        pub directory: RefCell<Option<String>>,
        pub filename: RefCell<Option<String>>,
        pub uri: RefCell<Option<String>>,
        // Path of filenames
        pub directory_pictures: RefCell<Vec<String>>,
        // Cell<T> allows for interior mutability of primitive types
        pub index: Cell<usize>,
    }

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

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

            klass.install_action("iv.next", None, move |image_view, _, _| {
                image_view.next();
            });

            klass.install_action("iv.previous", None, move |image_view, _, _| {
                image_view.previous();
            });
        }

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

    impl ObjectImpl for LpImageView {
        fn properties() -> &'static [glib::ParamSpec] {
            static PROPERTIES: Lazy<Vec<glib::ParamSpec>> = Lazy::new(|| {
                vec![
                    glib::ParamSpecString::new(
                        "filename",
                        "Filename",
                        "The filename of the current file",
                        None,
                        glib::ParamFlags::READABLE,
                    ),
                    glib::ParamSpecObject::new(
                        "controls",
                        "Controls",
                        "The controls for the image view",
                        gtk::Box::static_type(),
                        glib::ParamFlags::READABLE,
                    ),
                ]
            });

            PROPERTIES.as_ref()
        }

        fn property(&self, _obj: &Self::Type, _id: usize, psec: &glib::ParamSpec) -> glib::Value {
            match psec.name() {
                "filename" => self.filename.borrow().to_value(),
                "controls" => self.controls.to_value(),
                _ => unimplemented!(),
            }
        }

        fn constructed(&self, obj: &Self::Type) {
            self.parent_constructed(obj);

            self.click_gesture
                .connect_pressed(clone!(@weak obj => move |_, _, x, y| {
                    obj.show_popover_at(x, y);
                }));

            self.press_gesture
                .connect_pressed(clone!(@weak obj => move |_, x, y| {
                    obj.show_popover_at(x, y);
                }));
        }
    }

    impl WidgetImpl for LpImageView {}
    impl BinImpl for LpImageView {}
}

glib::wrapper! {
    pub struct LpImageView(ObjectSubclass<imp::LpImageView>)
        @extends gtk::Widget, adw::Bin,
        @implements gtk::Buildable, gtk::ConstraintTarget, gtk::Orientable;
}

impl LpImageView {
    pub fn set_image_from_file(&self, file: &gio::File) -> anyhow::Result<(i32, i32)> {
        let imp = imp::LpImageView::from_instance(&self);

        if let Some(current_file) = imp.picture.file() {
            if current_file.path().as_deref() == file.path().as_deref() {
                return Err(anyhow::Error::msg(
                    "Image is the same as the previous image; Doing nothing.",
                ));
            }
        }

        self.set_parent_from_file(file);
        imp.picture.set_file(file);
        *imp.uri.borrow_mut() = Some(file.uri().to_string());
        self.notify("filename");
        self.update_action_state();

        let width = imp.picture.image_width();
        let height = imp.picture.image_height();

        log::debug!("Image dimensions: {} x {}", width, height);
        Ok((width, height))
    }

    fn set_parent_from_file(&self, file: &gio::File) {
        let imp = imp::LpImageView::from_instance(&self);

        if let Some(parent) = file.parent() {
            let parent_path = parent.path().map(|p| p.to_str().unwrap().to_string());
            let mut directory_vec = imp.directory_pictures.borrow_mut();

            if parent_path.as_deref() != imp.directory.borrow().as_deref() {
                *imp.directory.borrow_mut() = parent_path;
                directory_vec.clear();

                let enumerator = parent
                    .enumerate_children(
                        &format!(
                            "{},{}",
                            *gio::FILE_ATTRIBUTE_STANDARD_DISPLAY_NAME,
                            *gio::FILE_ATTRIBUTE_STANDARD_CONTENT_TYPE
                        ),
                        gio::FileQueryInfoFlags::NONE,
                        gio::Cancellable::NONE,
                    )
                    .unwrap();

                // Filter out non-images; For now we support "all" image types.
                enumerator.for_each(|info| {
                    if let Ok(info) = info {
                        if let Some(content_type) = info.content_type().map(|t| t.to_string()) {
                            let filename = info.display_name().to_string();
                            log::debug!("Filename: {}", filename);
                            log::debug!("Mimetype: {}", content_type);

                            if content_type.starts_with("image/") {
                                log::debug!("{} is an image, adding to the list", filename);
                                directory_vec.push(filename);
                            }
                        }
                    }
                });

                // Then sort by name.
                directory_vec.sort_by(|name_a, name_b| {
                    util::utf8_collate_key_for_filename(name_a)
                        .cmp(&util::utf8_collate_key_for_filename(name_b))
                });

                log::debug!("Sorted files: {:?}", directory_vec);
            }

            *imp.filename.borrow_mut() = util::get_file_display_name(file);

            imp.index.set(
                directory_vec
                    .iter()
                    .position(|f| Some(f) == imp.filename.borrow().as_ref())
                    .unwrap(),
            );

            log::debug!("Current index is {}", imp.index.get());
        }
    }

    fn update_image(&self) {
        let imp = imp::LpImageView::from_instance(&self);

        let path = &format!(
            "{}/{}",
            imp.directory.borrow().as_ref().unwrap(),
            &imp.directory_pictures.borrow()[imp.index.get()]
        );

        let file = gio::File::for_path(path);
        imp.picture.set_file(&file);
        *imp.uri.borrow_mut() = Some(file.uri().to_string());
        *imp.filename.borrow_mut() = util::get_file_display_name(&file);
        self.notify("filename");
        self.update_action_state();
    }

    pub fn next(&self) {
        let imp = imp::LpImageView::from_instance(&self);
        // TODO: Replace with `Cell::update()` once stabilized
        imp.index.set(imp.index.get() + 1);
        self.update_image();
    }

    pub fn previous(&self) {
        let imp = imp::LpImageView::from_instance(&self);
        // TODO: Replace with `Cell::update()` once stabilized
        imp.index.set(imp.index.get() - 1);
        self.update_image();
    }

    pub fn update_action_state(&self) {
        let imp = imp::LpImageView::from_instance(&self);
        let index = imp.index.get();
        self.action_set_enabled("iv.next", index < imp.directory_pictures.borrow().len() - 1);
        self.action_set_enabled("iv.previous", index > 0);
    }

    pub fn set_wallpaper(&self) -> anyhow::Result<()> {
        let wallpaper = self.uri().context("No URI for current file")?;
        let ctx = glib::MainContext::default();
        ctx.spawn_local(async move {
            set_wallpaper(wallpaper).await;
        });

        Ok(())
    }

    pub fn print(&self) -> anyhow::Result<()> {
        let imp = imp::LpImageView::from_instance(&self);

        let operation = gtk::PrintOperation::new();
        let path = &format!(
            "{}/{}",
            imp.directory.borrow().as_ref().unwrap(),
            &imp.directory_pictures.borrow()[imp.index.get()]
        );
        let pb = gdk_pixbuf::Pixbuf::from_file(path)?;

        let setup = gtk::PageSetup::default();
        let page_size = gtk::PaperSize::new(Some(&gtk::PAPER_NAME_A4));
        setup.set_paper_size(&page_size);
        operation.set_default_page_setup(Some(&setup));

        let settings = gtk::PrintSettings::default();
        operation.set_print_settings(Some(&settings));

        operation.connect_begin_print(move |op, _| {
            op.set_n_pages(1);
        });

        // FIXME: Rework all of this after reading https://cairographics.org/manual/cairo-Image-Surfaces.html
        // Since I don't know cairo; See also eog-print.c
        operation.connect_draw_page(clone!(@weak pb => move |_, ctx, _| {
            let cr = ctx.cairo_context().expect("No cairo context for print context");
            cr.set_source_pixbuf(&pb, 0.0, 0.0);
            let _ = cr.paint();
        }));

        log::debug!("Running print operation...");
        let root = self.root().context("Could not get root for widget")?;
        let window = root
            .downcast_ref::<gtk::Window>()
            .context("Could not downcast to GtkWindow")?;
        operation.run(gtk::PrintOperationAction::PrintDialog, Some(window))?;

        Ok(())
    }

    pub fn uri(&self) -> Option<String> {
        let imp = imp::LpImageView::from_instance(&self);
        imp.uri.borrow().to_owned()
    }

    pub fn filename(&self) -> Option<String> {
        let imp = imp::LpImageView::from_instance(&self);
        imp.filename.borrow().to_owned()
    }

    pub fn show_popover_at(&self, x: f64, y: f64) {
        let imp = imp::LpImageView::from_instance(&self);

        let rect = gdk::Rectangle::new(x as i32, y as i32, 0, 0);

        imp.popover.set_pointing_to(&rect);
        imp.popover.popup();
    }
}

async fn set_wallpaper(uri: String) {
    if let Err(e) = wallpaper::set_from_uri(
        &WindowIdentifier::default(),
        &uri,
        true,
        wallpaper::SetOn::Background,
    )
    .await
    {
        log::error!(
            "Failed to set the wallpaper using the freedesktop portal: {}",
            e
        );
    }
}