feat(attach): add attachment links

Author: troiganto

lua/orgmode/attach/core.lua

@@ -395,6 +395,8 @@ function AttachCore:attach(node, file, opts)
         return nil
       end
       node:toggle_auto_tag(true)
+      local link = self.links:store_link_to_attachment({ attach_dir = attach_dir, original = file })
+      vim.fn.setreg(vim.v.register, link)
       return basename
     end)
   end)
@@ -420,6 +422,8 @@ function AttachCore:attach_url(node, url, opts)
         return nil
       end
       node:toggle_auto_tag(true)
+      local link = self.links:store_link_to_attachment({ attach_dir = attach_dir, original = url })
+      vim.fn.setreg(vim.v.register, link)
       return basename
     end)
   end)
@@ -445,6 +449,14 @@ function AttachCore:attach_buffer(node, bufnr, opts)
         return nil
       end
       node:toggle_auto_tag(true)
+      -- Ignore all errors here, this is just to determine whether we can store
+      -- a link to `bufname`.
+      local bufname_exists = vim.uv.fs_stat(bufname)
+      local link = self.links:store_link_to_attachment({
+        attach_dir = attach_dir,
+        original = bufname_exists and bufname or attach_file,
+      })
+      vim.fn.setreg(vim.v.register, link)
       return basename
     end)
   end)
@@ -472,7 +484,10 @@ function AttachCore:attach_many(node, files, opts)
       .mapSeries(function(to_be_attached)
         local basename = basename_safe(to_be_attached)
         local attach_file = vim.fs.joinpath(attach_dir, basename)
-        return attach(to_be_attached, attach_file)
+        return attach(to_be_attached, attach_file):next(function(success)
+          self.links:store_link_to_attachment({ attach_dir = attach_dir, original = to_be_attached })
+          return success
+        end)
       end, files)
       ---@param successes boolean[]
       :next(function(successes)

lua/orgmode/org/links/init.lua

@@ -62,8 +62,11 @@ function OrgLinks:autocomplete(link)
 end
 
 ---@param headline OrgHeadline
+---@return string url
 function OrgLinks:store_link_to_headline(headline)
-  self.stored_links[self:get_link_to_headline(headline)] = headline:get_title()
+  local url = self:get_link_to_headline(headline)
+  self.stored_links[url] = headline:get_title()
+  return url
 end
 
 ---@param headline OrgHeadline
@@ -96,6 +99,41 @@ function OrgLinks:get_link_to_file(file)
   return ('file:%s::*%s'):format(file.filename, title)
 end
 
+---@param params {attach_dir: string, original: string}
+---@return string | nil url
+function OrgLinks:store_link_to_attachment(params)
+  local url = self:get_link_to_attachment(params)
+  if url then
+    self.stored_links[url] = vim.fs.basename(params.original)
+  end
+  return url
+end
+
+---@param params {attach_dir: string, original: string}
+---@return string | nil url
+function OrgLinks:get_link_to_attachment(params)
+  vim.validate({
+    attach_dir = { params.attach_dir, 'string' },
+    original = { params.original, 'string' },
+  })
+  local basename = vim.fs.basename(params.original)
+  local choice = config.org_attach_store_link_p
+  if choice == 'attached' then
+    return string.format('attachment:%s', basename)
+  elseif choice == 'file' then
+    local attach_file = vim.fs.joinpath(params.attach_dir, basename)
+    return string.format('file:%s', attach_file)
+  elseif choice == 'original' then
+    -- Sanity check: `original` might be a URL. Check for that and return it
+    -- unmodified if yes.
+    if params.original:match('^[A-Za-z]+://') then
+      return params.original
+    end
+    return string.format('file:%s', params.original)
+  end
+  return nil
+end
+
 ---@param link_location string
 function OrgLinks:insert_link(link_location, desc)
   local selected_link = OrgHyperlink:new(link_location)

lua/orgmode/org/links/types/attachment.lua

@@ -0,0 +1,57 @@
+---@class OrgLinkAttachment:OrgLinkType
+---@field private attach OrgAttach
+local OrgLinkAttachment = {}
+OrgLinkAttachment.__index = OrgLinkAttachment
+
+---@param opts { attach: OrgAttach }
+function OrgLinkAttachment:new(opts)
+  local this = setmetatable({
+    attach = opts.attach,
+  }, OrgLinkAttachment)
+  return this
+end
+
+---@return string
+function OrgLinkAttachment:get_name()
+  return 'attachment'
+end
+
+---@param link string
+---@return boolean
+function OrgLinkAttachment:follow(link)
+  local opts = self:_parse(link)
+  if not opts then
+    return false
+  end
+  self.attach:open(opts.basename, opts.node)
+  return true
+end
+
+---@param link string
+---@return string[]
+function OrgLinkAttachment:autocomplete(link)
+  local opts = self:_parse(link)
+  if not opts then
+    return {}
+  end
+  local complete = self.attach:make_completion({ node = opts.node })
+  return vim.tbl_map(function(name)
+    return 'attachment:' .. name
+  end, complete(opts.basename))
+end
+
+---@private
+---@param link string
+---@return { node: OrgAttachNode, basename: string } | nil
+function OrgLinkAttachment:_parse(link)
+  local basename = link:match('^attachment:(.+)$')
+  if not basename then
+    return nil
+  end
+  return {
+    node = self.attach:get_current_node(),
+    basename = basename,
+  }
+end
+
+return OrgLinkAttachment