BackupDeviceBox.vala

Go to the documentation of this file.

/*
 * BackupDeviceBox.vala
 */
 
using Gtk;
using Gee;
 
using TeeJee.Logging;
using TeeJee.FileSystem;
using TeeJee.JsonHelper;
using TeeJee.ProcessHelper;
using TeeJee.GtkHelper;
using TeeJee.System;
using TeeJee.Misc;
 
class BackupDeviceBox : Gtk.Box{
 
    private Gtk.ListBox device_list;
    private Gtk.Box infobar_location;
    private Gtk.Label lbl_infobar_location;
    private Gtk.Label lbl_common;
    private Gtk.Window parent_window;
 
    public BackupDeviceBox (Gtk.Window _parent_window) {
        log_debug("BackupDeviceBox: BackupDeviceBox()");
        GLib.Object(orientation: Gtk.Orientation.VERTICAL, spacing: 6);
        parent_window = _parent_window;
        margin_top = 12;
        margin_bottom = 12;
        margin_start = 12;
        margin_end = 12;
 
        var hbox = new Gtk.Box(Gtk.Orientation.HORIZONTAL, 6);
        append(hbox);
        add_label_header(hbox, _("Select Snapshot Location"), true);
 
        // Spacer that pushes the toolbar buttons to the right.
        var spacer = add_label(hbox, "");
        spacer.hexpand = true;
 
        // Toolbar buttons live in their own little hbox with NO size
        // group: each one sizes naturally to its label so the long
        // "Add Network Share…" doesn't drag the short "Refresh" out.
        var toolbar = new Gtk.Box(Gtk.Orientation.HORIZONTAL, 6);
        toolbar.halign = Gtk.Align.END;
        toolbar.valign = Gtk.Align.CENTER;
        hbox.append(toolbar);
 
        // "Add Network Share" — only shown for the rsync mode because BTRFS
        // snapshots cannot live on a non-BTRFS network share.
        if (!App.btrfs_mode){
            var btn_smb = add_button(toolbar, _("Add Network Share…"),
                _("Mount a Samba/CIFS share (NAS, shared folder) and use it as a snapshot location"),
                null, null);
            btn_smb.add_css_class("btn-toolbar");
            btn_smb.hexpand = false;
            var lbl = btn_smb.get_child();
            if (lbl is Gtk.Label){
                ((Gtk.Label) lbl).wrap = false;
                ((Gtk.Label) lbl).ellipsize = Pango.EllipsizeMode.NONE;
            }
            btn_smb.clicked.connect(() => {
                on_add_smb_share_clicked();
            });
        }
 
        var btn_refresh = add_button(toolbar, _("Refresh"), "", null, null);
        btn_refresh.add_css_class("btn-toolbar");
        btn_refresh.hexpand = false;
        {
            var lbl = btn_refresh.get_child();
            if (lbl is Gtk.Label){
                ((Gtk.Label) lbl).wrap = false;
                ((Gtk.Label) lbl).ellipsize = Pango.EllipsizeMode.NONE;
            }
        }
        btn_refresh.clicked.connect(()=>{
            App.update_partitions();
            refresh();
        });
 
        init_device_list();
        init_infobar_location();
        log_debug("BackupDeviceBox: BackupDeviceBox(): exit");
    }
 
    public void refresh(){
        device_list_refresh();
        check_backup_location();
 
        if (App.btrfs_mode){
            lbl_common.label = "<i>• %s\n• %s\n• %s</i>".printf(
                _("Devices displayed above have BTRFS file systems."),
                _("BTRFS snapshots are saved on system partition. Other partitions are not supported."),
                _("Snapshots are saved to /bastionguard-backup-btrfs on selected partition. Other locations are not supported.")
            );
        }
        else {
            lbl_common.label = "<i>• %s\n• %s\n• %s\n• %s</i>".printf(
                _("Devices displayed above have Linux file systems."),
                _("Devices with Windows file systems are not supported (NTFS, FAT, etc)."),
                _("Network shares (SMB / NAS / shared folders) can be added with the button above."),
                _("On a local device snapshots are saved to /bastionguard-backup; on a network share they are saved to a bastionguard-backup folder inside the share.")
            );
        }
    }
 
    private void init_device_list(){
        device_list = new Gtk.ListBox();
        device_list.selection_mode = Gtk.SelectionMode.SINGLE;
        device_list.activate_on_single_click = true;
        device_list.add_css_class("boxed-list");
        device_list.row_selected.connect((row) => {
            if (row == null){
                return;
            }
            SmbShare? smb = row.get_data<SmbShare>("smb_share");
            if (smb != null){
                try_change_smb_share(smb);
                update_selected_rows();
                return;
            }
            Device? dev = row.get_data<Device>("device");
            if (dev != null){
                try_change_device(dev);
                update_selected_rows();
            }
        });
 
        var scrolled = new Gtk.ScrolledWindow();
        scrolled.hexpand = true;
        scrolled.vexpand = true;
        scrolled.set_policy(Gtk.PolicyType.NEVER, Gtk.PolicyType.AUTOMATIC);
        scrolled.set_child(device_list);
        append(scrolled);
    }
 
    private void add_device_row(Device dev, string kind){
        var row = new Gtk.ListBoxRow();
        row.set_data<Device>("device", dev);
 
        var outer = new Gtk.Box(Gtk.Orientation.HORIZONTAL, 12);
        outer.margin_top = 6;
        outer.margin_bottom = 6;
        outer.margin_start = 6;
        outer.margin_end = 6;
 
        var icon = IconManager.lookup_image((dev.type == "disk") ? IconManager.ICON_HARDDRIVE : "drive-harddisk-symbolic", 16);
        outer.append(icon);
 
        var primary = new Gtk.Box(Gtk.Orientation.VERTICAL, 2);
        primary.hexpand = true;
        string title = (dev.type == "disk") ? "%s %s".printf(dev.model, dev.vendor).strip() : dev.kname;
        if (title.length == 0){
            title = dev.description();
        }
        var title_label = new Gtk.Label(title);
        title_label.xalign = 0.0f;
        title_label.add_css_class("heading");
        primary.append(title_label);
 
        string details = "%s • %s".printf((kind.length > 0 ? kind : dev.fstype), format_file_size(dev.size_bytes, false, "", true, 0));
        if ((dev.type != "disk") && (dev.free_bytes > 0)){
            details += " • " + _("Free") + ": " + format_file_size(dev.free_bytes, false, "", true, 0);
        }
        if ((dev.partlabel != null) && (dev.partlabel.length > 0)){
            details += " • " + dev.partlabel;
        }
        var subtitle = new Gtk.Label(details);
        subtitle.xalign = 0.0f;
        subtitle.wrap = true;
        primary.append(subtitle);
        outer.append(primary);
 
        var status = new Gtk.Label("");
        status.xalign = 1.0f;
        status.set_data<string>("uuid", dev.uuid);
        outer.append(status);
 
        row.set_child(outer);
        device_list.append(row);
    }
 
    private void update_selected_rows(){
        Gtk.Widget? child = device_list.get_first_child();
        while (child != null){
            var next = child.get_next_sibling();
            if (child is Gtk.ListBoxRow){
                var row = (Gtk.ListBoxRow) child;
                Gtk.Widget? boxw = row.get_child();
                if (boxw is Gtk.Box){
                    Gtk.Widget? last = ((Gtk.Box) boxw).get_last_child();
                    if (last is Gtk.Label){
                        bool selected = false;
 
                        SmbShare? smb = row.get_data<SmbShare>("smb_share");
                        if (smb != null){
                            // SMB row: selected when repo is path-based and points
                            // at this share's mount point.
                            selected = (App.repo != null)
                                && (App.repo.device == null)
                                && (App.repo.mount_path == smb.mount_point + (smb.subpath.length > 0 ? "/" + smb.subpath : ""));
                        }
                        else {
                            Device? dev = row.get_data<Device>("device");
                            if (dev != null){
                                selected = (App.repo.device != null) && (App.repo.device.uuid == dev.uuid);
                            }
                        }
 
                        ((Gtk.Label) last).label = selected ? "✓" : "";
                    }
                }
            }
            child = next;
        }
    }
 
    private void init_infobar_location(){
        var infobar = new Gtk.Box(Gtk.Orientation.VERTICAL, 0);
        infobar.visible = false;
        append(infobar);
        infobar_location = infobar;
        
        var content = infobar;
        var label = add_label(content, "");
        lbl_infobar_location = label;
 
        var scrolled = new Gtk.ScrolledWindow();
        scrolled.set_policy(Gtk.PolicyType.NEVER, Gtk.PolicyType.NEVER);
        scrolled.set_size_request(-1, 100);
        append(scrolled);
        
        label = new Gtk.Label("");
        label.set_use_markup(true);
        label.xalign = 0.0f;
        label.wrap = true;
        label.wrap_mode = Pango.WrapMode.WORD;
        label.margin_top = 6;
        label.margin_bottom = 6;
        label.margin_start = 6;
        label.margin_end = 6;
        scrolled.set_child(label);
        lbl_common = label;
    }
 
    private void try_change_device(Device dev){
        log_debug("try_change_device: %s".printf(dev.device));
        if (dev.type == "disk"){
            bool found_child = false;
            if ((App.btrfs_mode && (dev.fstype == "btrfs")) || (!App.btrfs_mode && dev.has_linux_filesystem())){
                change_backup_device(dev);
                found_child = true;
            }
            if (!found_child){
                foreach (var child in dev.children){
                    if ((App.btrfs_mode && (child.fstype == "btrfs")) || (!App.btrfs_mode && child.has_linux_filesystem())){
                        change_backup_device(child);
                        found_child = true;
                        break;
                    }
                }
            }
            if (!found_child){
                string msg = App.btrfs_mode ? _("Selected device does not have BTRFS partition") : _("Selected device does not have Linux partition");
                lbl_infobar_location.label = "<span weight=\"bold\">%s</span>".printf(msg);
                infobar_location.show();
            }
        }
        else if (dev.has_children()){
            change_backup_device(dev.children[0]);
        }
        else if (!dev.has_children()){
            change_backup_device(dev);
        }
        else {
            lbl_infobar_location.label = "<span weight=\"bold\">%s</span>".printf(_("Select a partition on this disk"));
            infobar_location.show();
        }
    }
 
    private void change_backup_device(Device pi){
        if ((App.repo.device != null) && (pi.uuid == App.repo.device.uuid)){ return; }
 
        gtk_set_busy(true, parent_window);
        log_msg("selected device: %s".printf(pi.device));
        App.repo = new SnapshotRepo.from_device(pi, parent_window, App.btrfs_mode);
 
        if (pi.fstype == "luks"){
            App.update_partitions();
            var dev = Device.find_device_in_list(App.partitions, pi.uuid);
            if (dev.has_children() && dev.children[0].has_linux_filesystem()){
                App.repo = new SnapshotRepo.from_device(dev.children[0], parent_window, App.btrfs_mode);
                device_list_refresh();
            }
        }
 
        check_backup_location();
        update_selected_rows();
        gtk_set_busy(false, parent_window);
    }
 
    private bool check_backup_location(){
        bool ok = true;
        App.repo.check_status();
        string message = escape_html(App.repo.status_message);
        string details = escape_html(App.repo.status_details);
        int status_code = App.repo.status_code;
        
        if (App.live_system()){
            switch (status_code){
            case SnapshotLocationStatus.NOT_SELECTED:
                lbl_infobar_location.label = "<span weight=\"bold\">%s</span>".printf(details);
                infobar_location.show();
                ok = false;
                break;
            case SnapshotLocationStatus.NOT_AVAILABLE:
            case SnapshotLocationStatus.READ_ONLY_FS:
            case SnapshotLocationStatus.HARDLINKS_NOT_SUPPORTED:
                lbl_infobar_location.label = "<span weight=\"bold\">%s</span>".printf(message);
                infobar_location.show();
                ok = false;
                break;
            case SnapshotLocationStatus.NO_BTRFS_SYSTEM:
                lbl_infobar_location.label = "<span weight=\"bold\">%s</span>".printf(details);
                infobar_location.show();
                ok = false;
                break;
            case SnapshotLocationStatus.NO_SNAPSHOTS_HAS_SPACE:
            case SnapshotLocationStatus.NO_SNAPSHOTS_NO_SPACE:
                lbl_infobar_location.label = "<span weight=\"bold\">%s</span>".printf(_("There are no snapshots on this device"));
                infobar_location.show();
                break;
            case SnapshotLocationStatus.HAS_SNAPSHOTS_NO_SPACE:
            case SnapshotLocationStatus.HAS_SNAPSHOTS_HAS_SPACE:
                infobar_location.hide();
                break;
            }
        }
        else{
            switch (status_code){
                case SnapshotLocationStatus.NOT_SELECTED:
                    lbl_infobar_location.label = "<span weight=\"bold\">%s</span>".printf(details);
                    infobar_location.show();
                    ok = false;
                    break;
                case SnapshotLocationStatus.NOT_AVAILABLE:
                case SnapshotLocationStatus.HAS_SNAPSHOTS_NO_SPACE:
                case SnapshotLocationStatus.NO_SNAPSHOTS_NO_SPACE:
                    lbl_infobar_location.label = "<span weight=\"bold\">%s</span>".printf(message.replace("<","&lt;"));
                    infobar_location.show();
                    ok = false;
                    break;
                case SnapshotLocationStatus.READ_ONLY_FS:
                case SnapshotLocationStatus.HARDLINKS_NOT_SUPPORTED:
                    lbl_infobar_location.label = "<span weight=\"bold\">%s</span>".printf(message);
                    infobar_location.show();
                    ok = false;
                    break;
                case SnapshotLocationStatus.NO_BTRFS_SYSTEM:
                    lbl_infobar_location.label = "<span weight=\"bold\">%s</span>".printf(details);
                    infobar_location.show();
                    ok = false;
                    break;
                case 3:
                case 0:
                    infobar_location.hide();
                    break;
            }
        }
        return ok;
    }
 
    private void device_list_refresh(){
        App.update_partitions();
        while (device_list.get_first_child() != null){
            device_list.remove(device_list.get_first_child());
        }
 
        foreach(var disk in App.partitions) {
            if (disk.type != "disk") { continue; }
            add_device_row(disk, _("Disk"));
            append_child_volumes(disk);
        }
 
        // Append currently-mounted SMB/CIFS shares as selectable
        // destinations (only meaningful in rsync mode).
        if (!App.btrfs_mode){
            var smb_mounts = SmbMount.list_active_mounts();
            foreach (var s in smb_mounts){
                add_smb_row(s);
            }
        }
 
        update_selected_rows();
    }
 
    private void append_child_volumes(Device parent){
        foreach(var part in App.partitions) {
            if (!part.has_linux_filesystem()){ continue; }
 
            if (App.btrfs_mode){
                if (part.is_encrypted_partition() && (!part.has_children() || (part.children[0].fstype == "btrfs"))){
                }
                else if (part.is_lvm_partition() && (!part.has_children() || (part.children[0].fstype == "btrfs"))){
                }
                else if (part.fstype == "btrfs"){
                }
                else{
                    continue;
                }
            }
            
            if (part.pkname == parent.kname) {
                add_device_row(part, part.fstype);
                append_child_volumes(part);
            }
            else if ((part.kname == parent.kname) && (part.type == "disk") && part.has_linux_filesystem() && !part.has_children()){
                var part2 = new Device();
                part2.copy_fields_from(part);
                part2.type = "part";
                part2.pkname = part.device.replace("/dev/","");
                part2.parent = part;
                add_device_row(part2, part2.fstype);
            }
        }
    }
 
    // ─── SMB / NAS support ──────────────────────────────────────────────
 
    private void add_smb_row(SmbShare share){
        var row = new Gtk.ListBoxRow();
        row.set_data<SmbShare>("smb_share", share);
 
        var outer = new Gtk.Box(Gtk.Orientation.HORIZONTAL, 12);
        outer.margin_top = 6;
        outer.margin_bottom = 6;
        outer.margin_start = 6;
        outer.margin_end = 6;
 
        var icon = IconManager.lookup_image("folder-remote-symbolic", 16);
        if (icon == null){
            icon = IconManager.lookup_image("network-server-symbolic", 16);
        }
        outer.append(icon);
 
        var primary = new Gtk.Box(Gtk.Orientation.VERTICAL, 2);
        primary.hexpand = true;
 
        var title_label = new Gtk.Label(share.display_name);
        title_label.xalign = 0.0f;
        title_label.add_css_class("heading");
        primary.append(title_label);
 
        // Try to report free space on the mount.
        string details = _("Network share (SMB / CIFS)");
        if (share.mount_point.length > 0){
            var df = Device.get_disk_space_using_df(share.mount_point);
            if (df.size > 0 && df[0].size_bytes > 0){
                details += " • " + format_file_size(df[0].size_bytes, false, "", true, 0);
                if (df[0].free_bytes > 0){
                    details += " • " + _("Free") + ": "
                        + format_file_size(df[0].free_bytes, false, "", true, 0);
                }
            }
            else {
                details += " • " + share.mount_point;
            }
        }
        var subtitle = new Gtk.Label(details);
        subtitle.xalign = 0.0f;
        subtitle.wrap = true;
        primary.append(subtitle);
        outer.append(primary);
 
        var status = new Gtk.Label("");
        status.xalign = 1.0f;
        outer.append(status);
 
        row.set_child(outer);
        device_list.append(row);
    }
 
    private void on_add_smb_share_clicked(){
        string err;
        if (!SmbMount.is_available(out err)){
            gtk_messagebox(_("Network shares not available"), err, parent_window, true);
            return;
        }
 
        var share = SmbShareDialog.run_dialog(parent_window);
        if (share == null){
            return; // user cancelled or mount failed (dialog already showed err)
        }
 
        // Refresh and switch to the new share.
        refresh();
        try_change_smb_share(share);
        update_selected_rows();
    }
 
    private void try_change_smb_share(SmbShare share){
        log_debug("try_change_smb_share: %s".printf(share.unc_path));
 
        gtk_set_busy(true, parent_window);
 
        // If the user supplied a sub-folder we point the repo at it.
        string repo_path = share.mount_point;
        if (share.subpath.length > 0){
            repo_path = path_combine(repo_path, share.subpath);
            dir_create(repo_path);
        }
 
        App.repo = new SnapshotRepo.from_path(repo_path, parent_window, App.btrfs_mode);
 
        check_backup_location();
        gtk_set_busy(false, parent_window);
    }
}