dbusUtils.js

/* LICENSE INFORMATION
 * 
 * Desktop Icons: Neo - A desktop icons extension for GNOME with numerous features, 
 * customizations, and optimizations.
 * 
 * Copyright 2021 Abdurahman Elmawi (cooper64doom@gmail.com)
 * 
 * This project is based on Desktop Icons NG (https://gitlab.com/rastersoft/desktop-icons-ng),
 * a desktop icons extension for GNOME licensed under the GPL v3.
 * 
 * This project is free and open source software as described in the GPL v3.
 * 
 * This project (Desktop Icons: Neo) is licensed under the GPL v3. To view the details of this license, 
 * visit https://www.gnu.org/licenses/gpl-3.0.html for the necessary information
 * regarding this project's license.
 */

const Gio = imports.gi.Gio;
const GLib = imports.gi.GLib;
var NautilusFileOperations2Proxy;
var FreeDesktopFileManagerProxy;
var GnomeNautilusPreviewProxy;
var SwitcherooControlProxyClass;
var SwitcherooControlProxy;
var discreteGpuAvailable;
var GnomeArchiveManagerProxy;
var GtkVfsMetadataProxy;

const NautilusFileOperations2Interface = `<node>
<interface name='org.gnome.Nautilus.FileOperations2'>
    <method name='CopyURIs'>
        <arg type='as' name='sources' direction='in'/>
        <arg type='s' name='destination' direction='in'/>
        <arg type='a{sv}' name='platform_data' direction='in'/>
    </method>
    <method name='MoveURIs'>
        <arg type='as' name='sources' direction='in'/>
        <arg type='s' name='destination' direction='in'/>
        <arg type='a{sv}' name='platform_data' direction='in'/>
    </method>
    <method name='EmptyTrash'>
        <arg type="b" name="ask_confirmation" direction='in'/>
        <arg type='a{sv}' name='platform_data' direction='in'/>
    </method>
    <method name='TrashURIs'>
        <arg type='as' name='uris' direction='in'/>
        <arg type='a{sv}' name='platform_data' direction='in'/>
    </method>
    <method name='DeleteURIs'>
        <arg type='as' name='uris' direction='in'/>
        <arg type='a{sv}' name='platform_data' direction='in'/>
    </method>
    <method name='CreateFolder'>
        <arg type='s' name='parent_uri' direction='in'/>
        <arg type='s' name='new_folder_name' direction='in'/>
        <arg type='a{sv}' name='platform_data' direction='in'/>
    </method>
    <method name='RenameURI'>
        <arg type='s' name='uri' direction='in'/>
        <arg type='s' name='new_name' direction='in'/>
        <arg type='a{sv}' name='platform_data' direction='in'/>
    </method>
    <method name='Undo'>
        <arg type='a{sv}' name='platform_data' direction='in'/>
    </method>
    <method name='Redo'>
        <arg type='a{sv}' name='platform_data' direction='in'/>
    </method>
    <property name="UndoStatus" type="i" access="read"/>
</interface>
</node>`;

const NautilusFileOperations2ProxyInterface = Gio.DBusProxy.makeProxyWrapper(NautilusFileOperations2Interface);

const FreeDesktopFileManagerInterface = `<node>
<interface name='org.freedesktop.FileManager1'>
    <method name='ShowItems'>
        <arg name='URIs' type='as' direction='in'/>
        <arg name='StartupId' type='s' direction='in'/>
    </method>
    <method name='ShowItemProperties'>
        <arg name='URIs' type='as' direction='in'/>
        <arg name='StartupId' type='s' direction='in'/>
    </method>
</interface>
</node>`;

const FreeDesktopFileManagerProxyInterface = Gio.DBusProxy.makeProxyWrapper(FreeDesktopFileManagerInterface);

const GnomeNautilusPreviewInterface = `<node>
<interface name='org.gnome.NautilusPreviewer'>
    <method name='ShowFile'>
        <arg name='FileUri' type='s' direction='in'/>
        <arg name='ParentXid' type='i' direction='in'/>
        <arg name='CloseIfShown' type='b' direction='in'/>
    </method>
</interface>
</node>`;

const GnomeNautilusPreviewProxyInterface = Gio.DBusProxy.makeProxyWrapper(GnomeNautilusPreviewInterface);

const SwitcherooControlInterface = `<node>
<interface name="net.hadess.SwitcherooControl">
    <property name="HasDualGpu" type="b" access="read"/>
    <property name="NumGPUs" type="u" access="read"/>
    <property name="GPUs" type="aa{sv}" access="read"/>
</interface>
</node>`;

const SWITCHEROO_CONTROL_BUS_NAME = 'net.hadess.SwitcherooControl';

function _switcherooProxyAppeared() {
    SwitcherooControlProxyClass = Gio.DBusProxy.makeProxyWrapper(SwitcherooControlInterface);
    SwitcherooControlProxy = new SwitcherooControlProxyClass(Gio.DBus.system,
        SWITCHEROO_CONTROL_BUS_NAME,
        '/net/hadess/SwitcherooControl',
        (proxy, error) => {
            if (error) {
                discreteGpuAvailable = false;
                log(error.message);
                return;
            }
            discreteGpuAvailable = SwitcherooControlProxy.HasDualGpu;
        });
}


const GnomeArchiveManagerInterface = `<node>
  <!-- org.gnome.ArchiveManager1:
       @short_description: Create and extract compressed archives
       This D-Bus interface is used to create and extract compressed archives.
    -->
    <interface name="org.gnome.ArchiveManager1">
    <!--
        GetSupportedTypes:
        @action: Can be one of the following values:
          *) create: create an archive that can contain many files.
          *) create_single_file: create an archive that can contain a single file.
          *) extract: extract the content of an archive.
        @types: The supported archive types described as an array of hash tables,
          where each hash table has the following keys:
          *) mime-type: the mime type relative to the archive type.
          *) default-extension: the extension to use for newly created archives.
          *) description: a human readable description of the archive type.
        Returns the supported archive types for a specific action.
      -->
    <method name="GetSupportedTypes">
      <arg name="action" type="s" direction="in"/>
      <arg name="types" type="aa{ss}" direction="out"/>
    </method>

    <!--
        AddToArchive:
        @archive: The archive URI.
        @files: The files to add to the archive, as an array of URIs.
        @use_progress_dialog: Whether to show the progress dialog.
        Adds the specified files to an archive.  If the archive already
        exists the archive is updated.
      -->
    <method name="AddToArchive">
      <arg name="archive" type="s" direction="in"/>
      <arg name="files" type="as" direction="in"/>
      <arg name="use_progress_dialog" type="b" direction="in"/>
    </method>

    <!--
        Compress:
        @files: The files to add to the archive, as an array of URIs.
        @destination: An optional destination, if not specified the folder of
          the first file in @files is used.
        @use_progress_dialog: Whether to show the progress dialog.
        Compresses a series of files in an archive. The user is asked to
        enter an archive name, archive type and other options.  In this case
        it's used the same dialog used by the "Compress..." command from the
        Nautilus context menu.
        If the user chooses an existing archive, the archive is updated.
      -->
    <method name='Compress'>
      <arg name="files" type="as" direction="in"/>
      <arg name="destination" type="s" direction="in"/>
      <arg name="use_progress_dialog" type="b" direction="in"/>
    </method>

    <!--
        Extract:
        @archive: The archive to extract.
        @destination: The location where to extract the archive.
        @use_progress_dialog: Whether to show the progress dialog.
        Extract an archive in a specified location.
      -->
    <method name="Extract">
      <arg name="archive" type="s" direction="in"/>
      <arg name="destination" type="s" direction="in"/>
      <arg name="use_progress_dialog" type="b" direction="in"/>
    </method>

    <!--
        ExtractHere:
        @archive: The archive to extract.
        @use_progress_dialog: Whether to show the progress dialog.
        Extract an archive in the archive's folder.
      -->
    <method name="ExtractHere">
      <arg name="archive" type="s" direction="in"/>
      <arg name="use_progress_dialog" type="b" direction="in"/>
    </method>

    <!--
        Progress:
        @fraction: number from 0.0 to 100.0 that indicates the percentage of
          completion of the operation.
        @details: text message that describes the current operation.
      -->
    <signal name="Progress">
      <arg name="fraction" type="d"/>
      <arg name="details" type="s"/>
    </signal>

  </interface>
</node>`

const GnomeArchiveManagerProxyInterface = Gio.DBusProxy.makeProxyWrapper(GnomeArchiveManagerInterface);

const GtkVfsMetadataInterface = `<node>
  <interface name='org.gtk.vfs.Metadata'>

    <method name="Set">
      <arg type='ay' name='treefile' direction='in'/>
      <arg type='ay' name='path' direction='in'/>
      <arg type='a{sv}' name='data' direction='in'/>
    </method>
    <method name="Remove">
      <arg type='ay' name='treefile' direction='in'/>
      <arg type='ay' name='path' direction='in'/>
    </method>
    <method name="Move">
      <arg type='ay' name='treefile' direction='in'/>
      <arg type='ay' name='path' direction='in'/>
      <arg type='ay' name='dest_path' direction='in'/>
    </method>
    <method name="GetTreeFromDevice">
      <arg type='u' name='major' direction='in'/>
      <arg type='u' name='minor' direction='in'/>
      <arg type='s' name='tree' direction='out'/>
    </method>
    <signal name="AttributeChanged">
      <arg type='s' name='tree_path'/>
      <arg type='s' name='file_path'/>
    </signal>

  </interface>
</node>`

const GtkVfsMetadataProxyInterface = Gio.DBusProxy.makeProxyWrapper(GtkVfsMetadataInterface);

function init() {
    NautilusFileOperations2Proxy = new NautilusFileOperations2ProxyInterface(
        Gio.DBus.session,
        'org.gnome.Nautilus',
        '/org/gnome/Nautilus/FileOperations2',
        (proxy, error) => {
            if (error) {
                log('Error connecting to Nautilus');
            }
        }
    );

  NautilusFileOperations2Proxy.platformData = params => {
    const inShell = typeof global !== 'undefined';
    const defaultParams = {
      timestamp: inShell ? global.get_current_time() :
        imports.gi.Gtk.get_current_event_time(),
      parentWindow: inShell ? null :
        imports.gi.Gtk.get_current_event().get_window(),
      windowPosition: 'center',
    };
    const { parentWindow, timestamp, windowPosition } = {
      ...defaultParams,
      ...params,
    };
    
    //Get rid of ?? that would error out old GNOME versions
    let { parentHandle } = { parentHandle: '' };
    if(params !== null && params !== undefined){
        parentHandle = params;
    }

    if (!parentHandle && parentWindow) {
      try {
        imports.gi.versions.GdkX11 = '3.0';
        const { GdkX11 } = imports.gi;
        const topLevel = parentWindow.get_effective_toplevel();

        if (topLevel.constructor.$gtype === GdkX11.X11Window.$gtype) {
          const xid = GdkX11.X11Window.prototype.get_xid.call(topLevel);
          parentHandle = `x11:${xid}`;
        } /* else if (topLevel instanceof GdkWayland.Toplevel) {
          FIXME: Need Gtk4 to use GdkWayland
          const handle = GdkWayland.Toplevel.prototype.export_handle.call(topLevel);
          parentHandle = `wayland:${handle}`;
        } */
      } catch (e) {
        logError(e, 'Impossible to determine the parent window');
      }
    }

    return {
      'parent-handle': new GLib.Variant('s', parentHandle),
      'timestamp': new GLib.Variant('u', timestamp),
      'window-position': new GLib.Variant('s', windowPosition),
    };
  }

    FreeDesktopFileManagerProxy = new FreeDesktopFileManagerProxyInterface(
        Gio.DBus.session,
        'org.freedesktop.FileManager1',
        '/org/freedesktop/FileManager1',
        (proxy, error) => {
            if (error) {
                log('Error connecting to Nautilus');
            }
        }
    );

    GnomeNautilusPreviewProxy = new GnomeNautilusPreviewProxyInterface(
        Gio.DBus.session,
        'org.gnome.NautilusPreviewer',
        '/org/gnome/NautilusPreviewer',
        (proxy, error) => {
            if (error) {
                log('Error connecting to Nautilus Previewer');
            }
        }
    );

    SwitcherooControlProxy = null;
    discreteGpuAvailable = false;
    Gio.DBus.system.watch_name(SWITCHEROO_CONTROL_BUS_NAME,
        Gio.BusNameWatcherFlags.NONE,
        _switcherooProxyAppeared,
        () => {
            SwitcherooControlProxy = null;
            discreteGpuAvailable = false;
        });

    GnomeArchiveManagerProxy = new GnomeArchiveManagerProxyInterface(
        Gio.DBus.session,
        'org.gnome.ArchiveManager1',
        '/org/gnome/ArchiveManager1',
        (proxy, error) => {
            if (error) {
                log('Error connecting to ArchiveManager');
            }
        }
    );

    GtkVfsMetadataProxy = new GtkVfsMetadataProxyInterface(
        Gio.DBus.session,
        'org.gtk.vfs.Metadata',
        '/org/gtk/vfs/metadata',
        (proxy, error) => {
            if (error) {
                log('Error connecting to Gio VFS metadata');
            }
        }
    );
}