From 3003c1f7bd5b65c076b33fe5ae986eeebdee6cce Mon Sep 17 00:00:00 2001 From: Manuel Giraud Date: Sat, 25 Feb 2023 19:27:07 +0100 Subject: [PATCH] New option 'image-dired-thumb-naming' (bug#61394) * lisp/image/image-dired.el (image-dired-thumb-naming): New user option to control thumbnail name. * lisp/image/image-dired-util.el (image-dired-thumb-name): Update to use new user option and compute contents SHA-1 if needed. (image-dired-contents-sha1): New function to compute the SHA-1 of the first 4KiB of a file. --- etc/NEWS | 4 ++ lisp/image/image-dired-util.el | 84 +++++++++++++++++++++------------- lisp/image/image-dired.el | 26 ++++++++++- 3 files changed, 79 insertions(+), 35 deletions(-) diff --git a/etc/NEWS b/etc/NEWS index 4b0e4e6bd46..eca4fdaafe8 100644 --- a/etc/NEWS +++ b/etc/NEWS @@ -192,6 +192,10 @@ This command adds a docstring comment to the current defun. If a comment already exists, point is only moved to the comment. It is bound to 'C-c C-d' in 'go-ts-mode'. +** Image Dired +*** New user option 'image-dired-thumb-naming'. +You can now configure how a thumbnail is named using this option. + * New Modes and Packages in Emacs 30.1 diff --git a/lisp/image/image-dired-util.el b/lisp/image/image-dired-util.el index a80b3afc0f3..3f6880fc807 100644 --- a/lisp/image/image-dired-util.el +++ b/lisp/image/image-dired-util.el @@ -30,6 +30,7 @@ (eval-when-compile (require 'cl-lib)) (defvar image-dired-dir) +(defvar image-dired-thumb-naming) (defvar image-dired-thumbnail-storage) (defconst image-dired--thumbnail-standard-sizes @@ -57,42 +58,59 @@ image-dired-dir (message "Thumbnail directory created: %s" image-dired-dir)) image-dired-dir)) +(defun image-dired-contents-sha1 (filename) + "Compute the SHA-1 of the first 4KiB of FILENAME's contents." + (with-temp-buffer + (insert-file-contents-literally filename nil 0 4096) + (sha1 (current-buffer)))) + (defun image-dired-thumb-name (file) "Return absolute file name for thumbnail FILE. -Depending on the value of `image-dired-thumbnail-storage', the -file name of the thumbnail will vary: -- For `use-image-dired-dir', make a SHA1-hash of the image file's - directory name and add that to make the thumbnail file name - unique. -- For `per-directory' storage, just add a subdirectory. -- For `standard' storage, produce the file name according to the - Thumbnail Managing Standard. Among other things, an MD5-hash - of the image file's directory name will be added to the - filename. -See also `image-dired-thumbnail-storage'." +Depending on the value of `image-dired-thumbnail-storage' and +`image-dired-thumb-naming', the file name of the thumbnail will +vary: + +- If `image-dired-thumbnail-storage' is set to one of the value + of `image-dired--thumbnail-standard-sizes', produce the file + name according to the Thumbnail Managing Standard. Among other + things, an MD5-hash of the image file's directory name will be + added to the file name. + +- Otherwise `image-dired-thumbnail-storage' is used to set the + directory where to store the thumbnail. In this latter case + the name given to the thumbnail depends on the value of + `image-dired-thumb-naming'. + +See also `image-dired-thumbnail-storage' and +`image-dired-thumb-naming'." (let ((file (expand-file-name file))) - (cond ((memq image-dired-thumbnail-storage - image-dired--thumbnail-standard-sizes) - (let ((thumbdir (cl-case image-dired-thumbnail-storage - (standard "thumbnails/normal") - (standard-large "thumbnails/large") - (standard-x-large "thumbnails/x-large") - (standard-xx-large "thumbnails/xx-large")))) - (expand-file-name - ;; MD5 is mandated by the Thumbnail Managing Standard. - (concat (md5 (concat "file://" file)) ".png") - (expand-file-name thumbdir (xdg-cache-home))))) - ((or (eq 'image-dired image-dired-thumbnail-storage) - ;; Maintained for backwards compatibility: - (eq 'use-image-dired-dir image-dired-thumbnail-storage)) - (expand-file-name (format "%s.jpg" (sha1 file)) - (image-dired-dir))) - ((eq 'per-directory image-dired-thumbnail-storage) - (expand-file-name (format "%s.thumb.jpg" - (file-name-nondirectory file)) - (expand-file-name - ".image-dired" - (file-name-directory file))))))) + (if (memq image-dired-thumbnail-storage + image-dired--thumbnail-standard-sizes) + (let ((thumbdir (cl-case image-dired-thumbnail-storage + (standard "thumbnails/normal") + (standard-large "thumbnails/large") + (standard-x-large "thumbnails/x-large") + (standard-xx-large "thumbnails/xx-large")))) + (expand-file-name + ;; MD5 and PNG is mandated by the Thumbnail Managing + ;; Standard. + (concat (md5 (concat "file://" file)) ".png") + (expand-file-name thumbdir (xdg-cache-home)))) + (let ((name (if (eq 'sha1-contents image-dired-thumb-naming) + (image-dired-contents-sha1 file) + ;; Defaults to SHA-1 of file name + (if (eq 'per-directory image-dired-thumbnail-storage) + (sha1 (file-name-nondirectory file)) + (sha1 file))))) + (cond ((or (eq 'image-dired image-dired-thumbnail-storage) + ;; Maintained for backwards compatibility: + (eq 'use-image-dired-dir image-dired-thumbnail-storage)) + (expand-file-name (format "%s.jpg" name) (image-dired-dir))) + ((eq 'per-directory image-dired-thumbnail-storage) + (expand-file-name (format "%s.jpg" name) + (expand-file-name + ".image-dired" + (file-name-directory file))))))))) (defvar image-dired-thumbnail-buffer "*image-dired*" "Image-Dired's thumbnail buffer.") diff --git a/lisp/image/image-dired.el b/lisp/image/image-dired.el index 8e2a75a418f..8d56fd1e462 100644 --- a/lisp/image/image-dired.el +++ b/lisp/image/image-dired.el @@ -162,8 +162,27 @@ image-dired-dir `image-dired-thumbnail-storage'." :type 'directory) +(defcustom image-dired-thumb-naming 'sha1-filename + "How `image-dired' names thumbnail files. +When set to `sha1-filename' the name of thumbnail is built by +computing the SHA-1 of the full file name of the image. + +When set to `sha1-contents' the name of thumbnail is built by +computing the SHA-1 of first 4KiB of the image contents (See +`image-dired-contents-sha1'). + +In both case, a \"jpg\" extension is appended to save as JPEG. + +The value of this option is ignored if Image-Dired is customized +to use the Thumbnail Managing Standard. See +`image-dired-thumbnail-storage'." + :type '(choice :tag "How to name thumbnail files" + (const :tag "SHA-1 of the image file name" sha1-filename) + (const :tag "SHA-1 of the image contents" sha1-contents)) + :version "30.1") + (defcustom image-dired-thumbnail-storage 'image-dired - "How `image-dired' stores thumbnail files. + "Where `image-dired' stores thumbnail files. There are three ways that Image-Dired can store and generate thumbnails: @@ -189,6 +208,9 @@ image-dired-thumbnail-storage Set this user option to `per-directory'. +To control the naming of thumbnails for alternatives (2) and (3) +above, customize the value of `image-dired-thumb-naming'. + To control the default size of thumbnails for alternatives (2) and (3) above, customize the value of `image-dired-thumb-size'. @@ -197,7 +219,7 @@ image-dired-thumbnail-storage For more information on the Thumbnail Managing Standard, see: https://specifications.freedesktop.org/thumbnail-spec/thumbnail-spec-latest.html" - :type '(choice :tag "How to store thumbnail files" + :type '(choice :tag "Where to store thumbnail files" (const :tag "Use image-dired-dir" image-dired) (const :tag "Thumbnail Managing Standard (normal 128x128)" standard) -- 2.39.1