add restore bind

Author: pynappo

doc/neo-tree.txt

@@ -993,7 +993,8 @@ MacOS:
 
 Linux:
 - `gio trash`
-- Neo-tree's Lua implementation of the FreeDesktop XDG trash spec.
+- Neo-tree's Lua implementation of the FreeDesktop XDG trash spec at
+  require('neo-tree.trash.freedesktop').
 
 Windows: `PowerShell` commands.
 
@@ -1044,7 +1045,6 @@ falling back to the built-ins:
 (Neo-tree will attempt to run every command in-order, and log output for each
 command that returns with a non-zero error code).
 
-
 3. Or a function that is entirely responsible for deletion, and returns a
    (true/false, string) result tuple. Return false to defer to builtin handlers,
    return true to succeed, error to stop.
@@ -1072,7 +1072,6 @@ command that returns with a non-zero error code).
     })
 <
 
-
 FILTERED ITEMS                                          *neo-tree-filtered-items*
 
 The `filesystem` source has a `filtered_items` section in it's config that

lua/neo-tree/defaults.lua

@@ -459,9 +459,9 @@ local config = {
       },
       ["A"] = "add_directory", -- also accepts the config.show_path and config.insert_as options.
       ["d"] = "delete",
-      -- ["d"] = "trash",
       ["T"] = "trash",
       ["u"] = "undo",  -- currently only supports trash.
+      ["U"] = "restore_from_trash", -- only works on files that are in the recycle bin
       ["r"] = "rename",
       ["y"] = "copy_to_clipboard",
       ["x"] = "cut_to_clipboard",

lua/neo-tree/sources/common/commands.lua

@@ -788,6 +788,44 @@ M.trash_visual = function(state, selected_nodes, callback)
   fs_actions.trash_nodes(paths_to_trash, callback, state)
 end
 
+M.restore_from_trash = function(state, callback)
+  local node = assert(state.tree:get_node())
+  if node.type ~= "file" and node.type ~= "directory" then
+    log.warn("The `trash` command can only be used on files and directories")
+    return
+  end
+  if node:get_depth() == 1 then
+    log.error(
+      "Will not trash root node "
+        .. node.path
+        .. ", please back out of the current directory if you want to trash the root node."
+    )
+    return
+  end
+  fs_actions.restore_node_from_trash(node.path, callback, state)
+end
+
+---@param callback fun(paths: string[])
+---@type neotree.TreeCommandVisual
+M.restore_from_trash_visual = function(state, selected_nodes, callback)
+  local paths_to_trash = {}
+  for _, node_to_trash in pairs(selected_nodes) do
+    if node_to_trash:get_depth() == 1 then
+      log.error(
+        "Will not trash root node "
+          .. node_to_trash.path
+          .. ", please back out of the current directory if you want to restore the root node."
+      )
+      return
+    end
+
+    if node_to_trash.type == "file" or node_to_trash.type == "directory" then
+      table.insert(paths_to_trash, node_to_trash.path)
+    end
+  end
+  fs_actions.restore_nodes_from_trash(paths_to_trash, callback, state)
+end
+
 M.undo = function(state)
   ---@alias neotree.State.UndoFunction fun()
   ---@alias neotree.State.Undostack neotree.State.UndoFunction[]

lua/neo-tree/sources/filesystem/lib/fs_actions.lua

@@ -747,7 +747,7 @@ end
 M.trash_node = function(path, callback, state)
   local _, name = utils.split_path(path)
 
-  log.trace("Deleting node:", path)
+  log.trace("Trashing node:", path)
   local stat = uv.fs_stat(path)
 
   local do_trash = function()
@@ -793,22 +793,88 @@ end
 ---@param callback fun(paths: string[])?
 ---@param state neotree.State?
 M.trash_nodes = function(paths, callback, state)
-  local msg = "Are you sure you want to delete " .. #paths .. " items?"
+  local msg = "Are you sure you want to trash " .. #paths .. " items?"
   inputs.confirm(msg, function(confirmed)
     if not confirmed then
       return
     end
 
-    local success, err, restorer = trash.trash(paths)
+    local success, err, restorefunc = trash.trash(paths)
     if not success then
       log.error(err)
     end
 
-    if state then
-      table.insert(state.undostack, function()
-        trash.restore(paths, restorer)
+    if state and restorefunc then
+      table.insert(state.undostack, restorefunc)
+    end
+    if callback then
+      vim.schedule(function()
+        callback(paths)
       end)
     end
+  end)
+end
+
+---@param path string
+---@param callback fun(path: string)?
+---@param state neotree.State?
+M.restore_node_from_trash = function(path, callback, state)
+  local _, name = utils.split_path(path)
+
+  log.trace("Restoring node:", path)
+  local stat = uv.fs_stat(path)
+
+  local do_trash = function()
+    local complete = vim.schedule_wrap(function()
+      events.fire_event(events.FILE_DELETED, path)
+      if callback then
+        callback(path)
+      end
+    end)
+
+    local event_result = events.fire_event(events.BEFORE_FILE_DELETE, path) or {}
+    if event_result.handled then
+      complete()
+      return
+    end
+
+    local paths = { path }
+    local success, err = trash.restore(paths)
+    if not success then
+      log.error("Could not restore " .. path .. " from trash", err)
+      return
+    end
+
+    complete()
+  end
+
+  local displayed_name = name
+  if stat and stat.type == "directory" then
+    displayed_name = name .. utils.path_separator
+  end
+  local msg = string.format("Are you sure you want to restore '%s'?", displayed_name)
+  inputs.confirm(msg, function(confirmed)
+    if confirmed then
+      do_trash()
+    end
+  end)
+end
+
+---@param paths string[]
+---@param callback fun(paths: string[])?
+---@param state neotree.State?
+M.restore_nodes_from_trash = function(paths, callback, state)
+  local msg = "Are you sure you want to restore " .. #paths .. " items?"
+  inputs.confirm(msg, function(confirmed)
+    if not confirmed then
+      return
+    end
+
+    local success, err = trash.restore(paths)
+    if not success then
+      log.error(err)
+    end
+
     if callback then
       vim.schedule(function()
         callback(paths)

lua/neo-tree/trash/freedesktop.lua

@@ -12,11 +12,11 @@ local function dir_is_writable(path)
   return stat and stat.type == "directory" and uv.fs_access(path, "w") or false
 end
 
----@param path string @param opts { recursive: boolean?, remove: boolean? }?
----@param mode number?
+---@param path string
+---@param opts { recursive: boolean?, remove: boolean?, mode: number? }?
 ---@return boolean success
 ---@return string? err
-local function mkdir(path, opts, mode)
+local function mkdir(path, opts)
   opts = opts or {}
   local stat = uv.fs_stat(path)
   if stat then
@@ -32,12 +32,12 @@ local function mkdir(path, opts, mode)
   local parent_stat = uv.fs_stat(parent_path)
   if not parent_stat then
     if opts.recursive then
-      mkdir(parent_path, opts, mode)
+      mkdir(parent_path, opts)
     else
       return false, "parent dir of " .. path .. " does not exist"
     end
   end
-  local res, err = uv.fs_mkdir(path, mode or tonumber("755", 8))
+  local res, err = uv.fs_mkdir(path, opts.mode or tonumber("755", 8))
   res = res or false
   return res, err
 end

lua/neo-tree/trash/gio.lua

@@ -0,0 +1,61 @@
+local utils = require("neo-tree.utils")
+local log = require("neo-tree.log")
+local M = {}
+
+---@param gvfs_paths string[]
+local restore = function(gvfs_paths)
+  local restore_ok =
+    utils.execute_command(vim.list_extend({ "gio", "trash", "--restore" }, gvfs_paths))
+  return restore_ok
+end
+
+---@type neotree.trash.FunctionGenerator
+M.generate_trashfunc = function(paths)
+  if not utils.executable("gio") then
+    return nil
+  end
+  local list_ok, before_list_output = utils.execute_command({ "gio", "trash", "--list" })
+  if not list_ok then
+    log.at.warn.format("Error with `gio trash --list`: %s", table.concat(before_list_output, "\n"))
+    return nil
+  end
+  local trashmap = {}
+  for _, line in ipairs(before_list_output) do
+    local tab_index = line:find("\t", 1, true)
+    if tab_index then
+      local trash_filepath = line:sub(1, tab_index - 1)
+      local original_filepath = line:sub(tab_index + 1)
+      trashmap[trash_filepath] = original_filepath
+    end
+  end
+  return function()
+    local trash_ok, trash_output = utils.execute_command(vim.list_extend({ "gio", "trash" }, paths))
+    if not trash_ok then
+      log.at.warn.format("Error with `gio trash`: %s", table.concat(trash_output, "\n"))
+    end
+
+    local after_trash_ok, after_list_output = utils.execute_command({ "gio", "trash", "--list" })
+    if not after_trash_ok then
+      log.at.warn.format(
+        "Error with 2nd `gio trash --list`: %s",
+        table.concat(after_list_output, "\n")
+      )
+    end
+    local new_trash_items = {}
+    for _, line in ipairs(after_list_output) do
+      local tab_index = line:find("\t", 1, true)
+      if tab_index then
+        local trash_filepath = line:sub(1, tab_index - 1)
+        if not trashmap[trash_filepath] then
+          new_trash_items[#new_trash_items + 1] = trash_filepath
+        end
+      end
+    end
+    ---@type neotree.trash._RestoreFunction
+    local restorefunc = function()
+      return restore(new_trash_items)
+    end
+    return true, restorefunc
+  end
+end
+return M