Extra image types (#99)

Author: chappertron

README.md

@@ -115,6 +115,7 @@ The plugin is highly configurable. Please refer to the default configuration bel
     process_cmd = "", ---@type string | fun(): string
     copy_images = false, ---@type boolean | fun(): boolean
     download_images = true, ---@type boolean | fun(): boolean
+    formats = { "jpeg", "jpg", "png" }, ---@type string[]
 
     -- drag and drop options
     drag_and_drop = {
@@ -151,6 +152,8 @@ The plugin is highly configurable. Please refer to the default configuration bel
   \label{fig:$LABEL}
 \end{figure}
     ]], ---@type string | fun(context: table): string
+
+      formats = { "jpeg", "jpg", "png", "pdf" }, ---@type table
     },
 
     typst = {

lua/img-clip/config.lua

@@ -40,6 +40,7 @@ local defaults = {
     process_cmd = "", ---@type string
     copy_images = false, ---@type boolean
     download_images = true, ---@type boolean
+    formats = { "jpeg", "jpg", "png" }, ---@type string[]
 
     -- drag and drop options
     drag_and_drop = {
@@ -76,6 +77,8 @@ local defaults = {
   \label{fig:$LABEL}
 \end{figure}
     ]], ---@type string
+
+      formats = { "jpeg", "jpg", "png", "pdf" }, ---@type table
     },
 
     typst = {
@@ -203,7 +206,7 @@ end
 ---get the value of the option, executing it if it's a function
 ---@param val any
 ---@param args? table
----@return string | nil
+---@return string | table | nil
 local function get_val(val, args)
   if val == nil then
     return nil
@@ -217,7 +220,7 @@ end
 ---get the option from the custom table
 ---@param key string
 ---@param args? table
----@return string | nil
+---@return string | table | nil
 local function get_custom_opt(key, opts, args)
   if opts["custom"] == nil then
     return nil
@@ -233,7 +236,7 @@ end
 ---get the option from the files table
 ---@param key string
 ---@param args? table
----@return string | nil
+---@return string | table | nil
 local function get_file_opt(key, opts, args, file)
   if opts["files"] == nil then
     return nil
@@ -255,7 +258,7 @@ end
 ---get the option from the dirs table
 ---@param key string
 ---@param args? table
----@return string | nil
+---@return string | table | nil
 local function get_dir_opt(key, opts, args, dir)
   if opts["dirs"] == nil then
     return nil
@@ -298,7 +301,7 @@ end
 ---@param key string: The key, may be nested (e.g. "default.debug")
 ---@param args? table: Args that should be passed to the option function
 ---@param opts? table: Opts passed explicitly to the function
----@return string | nil
+---@return string | table | nil
 M.get_opt = function(key, args, opts)
   -- use explicit opts if provided
   -- otherwise, try to get the value from the api_opts

lua/img-clip/mime_types.lua

@@ -0,0 +1,132 @@
+local M = {}
+
+--- Check if the MIME type is a supported format
+--- @param mime_type string
+--- @param supported_formats string[]
+--- @return boolean
+M.is_supported_mime_type = function(mime_type, supported_formats)
+  local mime_fmts = M.formats_from_mime_type(mime_type)
+
+  -- Handle unknown formats
+  if mime_fmts == nil then
+    return false
+  end
+
+  -- Convert into a set (https://www.lua.org/pil/11.5.html)
+  local valid_formats = {}
+  for _, format in ipairs(supported_formats) do
+    valid_formats[format] = true
+  end
+
+  for _, fmt in pairs(mime_fmts) do
+    if valid_formats[fmt] ~= nil then
+      return true
+    end
+  end
+
+  return false
+end
+
+-- Return a table of the image format extensions corresponding to this mime type
+--- @return string[]
+M.formats_from_mime_type = function(mime_type)
+  local mime_fmts = M.mime_types[mime_type]
+
+  if type(mime_fmts) == "string" then
+    -- Make a table, because multiple formats could map to the MIME type
+    mime_fmts = { mime_fmts }
+  end
+
+  return mime_fmts
+end
+
+-- A table of common MIME types mapping to file extensions.
+-- Based on public documentation and observed conventions across platforms.
+M.mime_types = {
+  ["audio/aac"] = "aac",
+  ["application/x-abiword"] = "abw",
+  ["image/apng"] = "apng",
+  ["application/x-freearc"] = "arc",
+  ["image/avif"] = "avif",
+  ["video/x-msvideo"] = "avi",
+  ["application/vnd.amazon.ebook"] = "azw",
+  ["application/octet-stream"] = "bin",
+  ["image/bmp"] = "bmp",
+  ["application/x-bzip"] = "bz",
+  ["application/x-bzip2"] = "bz2",
+  ["application/x-cdf"] = "cda",
+  ["application/x-csh"] = "csh",
+  ["text/css"] = "css",
+  ["text/csv"] = "csv",
+  ["application/msword"] = "doc",
+  ["application/vnd.openxmlformats-officedocument.wordprocessingml.document"] = "docx",
+  ["application/vnd.ms-fontobject"] = "eot",
+  ["application/epub+zip"] = "epub",
+  ["application/gzip"] = "gz",
+  -- Windows and macOS upload `.gz` files with this the non-standard MIME type.
+  ["application/x-gzip"] = "gz",
+  ["image/gif"] = "gif",
+  ["text/html"] = { "htm", "html" },
+  ["image/vnd.microsoft.icon"] = "ico",
+  ["text/calendar"] = "ics",
+  ["application/java-archive"] = "jar",
+  ["image/jpeg"] = { "jpeg", "jpg" },
+  -- (Specifications: HTML and RFC 9239)
+  ["text/javascript "] = "js",
+  ["application/json"] = "json",
+  ["application/ld+json"] = "jsonld",
+  ["audio/midi, audio/x-midi"] = { "mid", "midi" },
+  ["text/javascript"] = "mjs",
+  ["audio/mpeg"] = "mp3",
+  ["video/mp4"] = "mp4",
+  ["video/mpeg"] = "mpeg",
+  ["application/vnd.apple.installer+xml"] = "mpkg",
+  ["application/vnd.oasis.opendocument.presentation"] = "odp",
+  ["application/vnd.oasis.opendocument.spreadsheet"] = "ods",
+  ["application/vnd.oasis.opendocument.text"] = "odt",
+  ["audio/ogg"] = { "oga", "opus" },
+  ["video/ogg"] = "ogv",
+  ["application/ogg"] = "ogx",
+  ["font/otf"] = "otf",
+  ["image/png"] = "png",
+  ["application/pdf"] = "pdf",
+  ["application/x-httpd-php"] = "php",
+  ["application/vnd.ms-powerpoint"] = "ppt",
+  ["application/vnd.openxmlformats-officedocument.presentationml.presentation"] = "pptx",
+  ["application/vnd.rar"] = "rar",
+  ["application/rtf"] = "rtf",
+  ["application/x-sh"] = "sh",
+  ["image/svg+xml"] = "svg",
+  ["application/x-tar"] = "tar",
+  ["image/tiff"] = { "tif", "tiff" },
+  ["video/mp2t"] = "ts",
+  ["font/ttf"] = "ttf",
+  ["text/plain"] = "txt",
+  ["application/vnd.visio"] = "vsd",
+  ["audio/wav"] = "wav",
+  ["audio/webm"] = "weba",
+  ["video/webm"] = "webm",
+  ["image/webp"] = "webp",
+  ["font/woff"] = "woff",
+  ["font/woff2"] = "woff2",
+  ["application/xhtml+xml"] = "xhtml",
+  ["application/vnd.ms-excel"] = "xls",
+  ["application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"] = "xlsx",
+  -- `application/xml` is recommended but `text/xml` is still commonly used.
+  -- The specific MIME types used depends on the content semantics.
+  ["application/xml"] = "xml",
+  ["text/xml"] = "xml",
+  ["application/vnd.mozilla.xul+xml"] = "xul",
+  ["application/zip"] = "zip",
+  -- Windows use this non-standard MIME type for `.zip` files.
+  ["application/x-zip-compressed"] = "zip",
+  ["video/3gpp"] = "3gp",
+  -- `audio/3gpp` if it doesn't contain video
+  ["audio/3gpp"] = "3gp",
+  ["video/3gpp2"] = "3g2",
+  -- `audio/3gpp2` if it doesn't contain video
+  ["audo/3gpp2"] = "3g2",
+  ["application/x-7z-compressed"] = "7z",
+}
+
+return M

lua/img-clip/util.lua

@@ -1,5 +1,6 @@
 local config = require("img-clip.config")
 local debug = require("img-clip.debug")
+local mime_types = require("img-clip.mime_types")
 
 local M = {}
 
@@ -111,14 +112,40 @@ M.is_image_url = function(str)
   end
 
   -- assume its a valid image link if it the url ends with an extension
-  if str:match("%.png$") or str:match("%.jpg$") or str:match("%.jpeg$") then
-    return true
+  local extension = str:match("%.(%w+)$") -- Assumes that the extensions are alphanumeric
+
+  local image_formats = config.get_opt("formats")
+
+  if extension ~= nil then
+    --- @cast image_formats table
+    for _, ext in ipairs(image_formats) do
+      if extension == ext then
+        return true
+      end
+    end
+
+    -- This format was not supported in the user's config
+    return false
   end
 
-  -- send a head request to the url and check content type
-  local command = string.format("curl -s -I -w '%%{content_type}' '%s'", str)
+  -- send a head request to the url and check content type.
+  -- Add the 'CONTENT_TYPE' text on the last line for easier matching
+  local command = string.format("curl -s -I -w 'CONTENT_TYPE: %%{content_type}' '%s'", str)
+
   local output, exit_code = M.execute(command)
-  return exit_code == 0 and output ~= nil and (output:match("image/png") ~= nil or output:match("image/jpeg") ~= nil)
+
+  if exit_code ~= 0 or output == nil then
+    return false
+  end
+
+  -- Match the content type
+  -- The capture group is any pattern, until the next semi-colon or white space.
+  -- Note this makes the assumption that the actual content type is first
+  ---@cast output string
+  local content_type = string.match(output, "CONTENT_TYPE:%s([^%s;]+)")
+
+  --- @cast image_formats table
+  return content_type ~= nil and mime_types.is_supported_mime_type(content_type, image_formats)
 end
 
 ---@param str string
@@ -127,11 +154,25 @@ M.is_image_path = function(str)
   str = string.lower(str)
 
   local has_path_sep = str:find("/") ~= nil or str:find("\\") ~= nil
-  local has_image_ext = str:match("^.*%.(png)$") ~= nil
-    or str:match("^.*%.(jpg)$") ~= nil
-    or str:match("^.*%.(jpeg)$") ~= nil
 
-  return has_path_sep and has_image_ext
+  local extension = str:match("%.(%w+)$") -- Assumes that the extensions are alphanumeric
+
+  if extension == nil then
+    return false
+  end
+
+  local formats = config.get_opt("formats")
+
+  local has_supported_format = false
+  --- @cast formats table
+  for _, ext in ipairs(formats) do
+    has_supported_format = has_supported_format or (ext == extension)
+    if has_supported_format then
+      break
+    end
+  end
+
+  return has_path_sep and has_supported_format
 end
 
 return M

tests/util_spec.lua

@@ -115,7 +115,7 @@ describe("util", function()
 
     it("should return true for a valid image URL without an extension but with image content type", function()
       util.execute = function()
-        return "image/png", 0
+        return "CONTENT_TYPE: image/png", 0
       end
       assert.is_true(util.is_image_url("http://example.com/image"))
     end)

vimdoc.md

@@ -115,6 +115,7 @@ The plugin is highly configurable. Please refer to the default configuration bel
     process_cmd = "", ---@type string | fun(): string
     copy_images = false, ---@type boolean | fun(): boolean
     download_images = true, ---@type boolean | fun(): boolean
+    formats = { "jpeg", "jpg", "png" }, ---@type string[]
 
     -- drag and drop options
     drag_and_drop = {
@@ -151,6 +152,8 @@ The plugin is highly configurable. Please refer to the default configuration bel
   \label{fig:$LABEL}
 \end{figure}
     ]], ---@type string | fun(context: table): string
+
+      formats = { "jpeg", "jpg", "png", "pdf" }, ---@type table
     },
 
     typst = {