emacs/lisp/gnus/gnus-fun.el

334 lines
11 KiB
EmacsLisp

;;; gnus-fun.el --- various frivolous extension functions to Gnus -*- lexical-binding: t; -*-
;; Copyright (C) 2002-2024 Free Software Foundation, Inc.
;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
;; Keywords: news
;; This file is part of GNU Emacs.
;; GNU Emacs is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
;;; Commentary:
;;; Code:
(require 'mm-util)
(require 'gnus-util)
(require 'gnus)
(defvar gnus-face-properties-alist)
(defcustom gnus-x-face-directory (expand-file-name "x-faces" gnus-directory)
"Directory where X-Face PBM files are stored."
:version "22.1"
:group 'gnus-fun
:type 'directory)
(defcustom gnus-x-face-omit-files nil
"Regexp to match faces in `gnus-x-face-directory' to be omitted."
:version "25.1"
:group 'gnus-fun
:type '(choice (const nil) regexp))
(defcustom gnus-face-directory (expand-file-name "faces" gnus-directory)
"Directory where Face PNG files are stored."
:version "25.1"
:group 'gnus-fun
:type 'directory)
(defcustom gnus-face-omit-files nil
"Regexp to match faces in `gnus-face-directory' to be omitted."
:version "25.1"
:group 'gnus-fun
:type '(choice (const nil) regexp))
(defcustom gnus-convert-pbm-to-x-face-command "pbmtoxbm %s | compface"
"Command for converting a PBM to an X-Face."
:version "22.1"
:group 'gnus-fun
:type 'string)
(defcustom gnus-convert-image-to-x-face-command
"convert -scale 48x48! %s xbm:- | xbm2xface.pl"
"Command for converting an image to an X-Face.
The command must take an image filename (use \"%s\") as input.
The output must be the X-Face header data on stdout."
:version "22.1"
:group 'gnus-fun
:type '(choice (const :tag "giftopnm, netpbm (GIF input only)"
"giftopnm %s | ppmnorm | pnmscale -width 48 -height 48 | ppmtopgm | pgmtopbm | pbmtoxbm | compface")
(const :tag "convert"
"convert -scale 48x48! %s xbm:- | xbm2xface.pl")
(string)))
(defcustom gnus-convert-image-to-face-command
"convert -scale 48x48! %s -colors %d png:-"
"Command for converting an image to a Face.
The command must take an image filename (first format argument
\"%s\") and the number of colors (second format argument: \"%d\")
as input. The output must be the Face header data on stdout in
PNG format."
:version "22.1"
:group 'gnus-fun
:type '(choice (const :tag "djpeg, netpbm (JPG input only)"
"djpeg %s | ppmnorm | pnmscale -width 48 -height 48 | ppmquant %d | pnmtopng")
(const :tag "convert"
"convert -scale 48x48! %s -colors %d png:-")
(string)))
(defun gnus-shell-command-to-string (command)
"Like `shell-command-to-string' except not mingling ERROR."
(with-output-to-string
(call-process shell-file-name nil (list standard-output nil)
nil shell-command-switch command)))
;;;###autoload
(defun gnus--random-face-with-type (dir ext omit fun)
"Return file from DIR with extension EXT.
Omit matches of OMIT, and process them by FUN."
(when (file-exists-p dir)
(let* ((files
(remove nil (mapcar
(lambda (f) (unless (string-match (or omit "^$") f) f))
(directory-files dir t ext))))
(file (and files (seq-random-elt files))))
(when file
(funcall fun file)))))
;;;###autoload
(autoload 'message-goto-eoh "message" nil t)
(autoload 'message-insert-header "message" nil t)
(defun gnus--insert-random-face-with-type (fun type)
"Get a random face using FUN and insert it as a header TYPE.
For instance, to insert an X-Face use `gnus-random-x-face' as FUN
and \"X-Face\" as TYPE."
(let ((data (funcall fun)))
(save-excursion
(if data
(progn (message-goto-eoh)
(insert type ": " data "\n"))
(message
"No face returned by the function %s." (symbol-name fun))))))
;;;###autoload
(defun gnus-random-x-face ()
"Return X-Face header data chosen randomly from `gnus-x-face-directory'.
Files matching `gnus-x-face-omit-files' are not considered."
(interactive)
(gnus--random-face-with-type
gnus-x-face-directory "\\.pbm$" gnus-x-face-omit-files
(lambda (file)
(gnus-shell-command-to-string
(format gnus-convert-pbm-to-x-face-command
(shell-quote-argument file))))))
;;;###autoload
(defun gnus-insert-random-x-face-header ()
"Insert a random X-Face header from `gnus-x-face-directory'."
(interactive)
(gnus--insert-random-face-with-type 'gnus-random-x-face 'X-Face))
;;;###autoload
(defun gnus-x-face-from-file (file)
"Insert an X-Face header based on an image FILE.
Depending on `gnus-convert-image-to-x-face-command' it may accept
different input formats."
(interactive "fImage file name: ")
(when (file-exists-p file)
(gnus-shell-command-to-string
(format gnus-convert-image-to-x-face-command
(shell-quote-argument (expand-file-name file))))))
;;;###autoload
(defun gnus-face-from-file (file)
"Return a Face header based on an image FILE.
Depending on `gnus-convert-image-to-face-command' it may accept
different input formats."
(interactive "fImage file name: ")
(when (file-exists-p file)
(let ((done nil)
(attempt "")
(quant 16))
(while (and (not done)
(> quant 1))
(setq attempt
(let ((coding-system-for-read 'binary))
(gnus-shell-command-to-string
(format gnus-convert-image-to-face-command
(shell-quote-argument (expand-file-name file))
quant))))
(if (> (length attempt) 726)
(progn
(setq quant (- quant (if (< quant 10) 1 2)))
(gnus-message 9 "Length %d; trying quant %d"
(length attempt) quant))
(setq done t)))
(if done
(mm-with-unibyte-buffer
(insert attempt)
(gnus-face-encode))
nil))))
(defun gnus-face-encode ()
(let ((step 72))
(base64-encode-region (point-min) (point-max))
(goto-char (point-min))
(while (search-forward "\n" nil t)
(replace-match ""))
(goto-char (point-min))
(while (> (- (point-max) (point))
step)
(forward-char step)
(insert "\n ")
(setq step 76))
(buffer-string)))
;;;###autoload
(defun gnus-convert-face-to-png (face)
"Convert FACE (which is base64-encoded) to a PNG.
The PNG is returned as a string."
(mm-with-unibyte-buffer
(insert face)
(ignore-errors
(base64-decode-region (point-min) (point-max)))
(buffer-string)))
;;;###autoload
(defun gnus-convert-png-to-face (file)
"Convert FILE to a Face.
FILE should be a PNG file that's 48x48 and smaller than or equal to
726 bytes."
(mm-with-unibyte-buffer
(insert-file-contents file)
(when (> (buffer-size) 726)
(error "The file is %d bytes long, which is too long"
(buffer-size)))
(gnus-face-encode)))
;;;###autoload
(defun gnus-random-face ()
"Return randomly chosen Face from `gnus-face-directory'.
Files matching `gnus-face-omit-files' are not considered."
(interactive)
(gnus--random-face-with-type gnus-face-directory "\\.png$"
gnus-face-omit-files
'gnus-convert-png-to-face))
;;;###autoload
(defun gnus-insert-random-face-header ()
"Insert a random Face header from `gnus-face-directory'."
(gnus--insert-random-face-with-type 'gnus-random-face 'Face))
(defface gnus-x-face '((t (:foreground "black" :background "white")))
"Face to show X-Face.
The colors from this face are used as the foreground and background
colors of the displayed X-Faces."
:group 'gnus-article-headers)
(declare-function article-narrow-to-head "gnus-art" ())
(declare-function gnus-article-goto-header "gnus-art" (header))
(declare-function gnus-add-image "gnus-art" (category image))
(declare-function gnus-add-wash-type "gnus-art" (type))
(defun gnus-display-x-face-in-from (data)
"Display the X-Face DATA in the From header."
(require 'gnus-art)
(let (pbm)
(when (or (gnus-image-type-available-p 'xface)
(and (gnus-image-type-available-p 'pbm)
(setq pbm (uncompface data))))
(save-excursion
(save-restriction
(article-narrow-to-head)
(gnus-article-goto-header "from")
(when (bobp)
(insert "From: [no 'from' set]\n")
(forward-char -17))
(gnus-add-image
'xface
(gnus-put-image
(if (gnus-image-type-available-p 'xface)
(apply #'gnus-create-image (concat "X-Face: " data) 'xface t
(cdr (assq 'xface gnus-face-properties-alist)))
(apply #'gnus-create-image pbm 'pbm t
(cdr (assq 'pbm gnus-face-properties-alist))))
nil 'xface))
(gnus-add-wash-type 'xface))))))
(defun gnus-grab-cam-x-face ()
"Grab a picture off the camera and make it into an X-Face."
(shell-command "xawtv-remote snap ppm")
(let ((file nil))
(while (null (setq file (directory-files "/tftpboot/sparky/tmp"
t "snap.*ppm")))
(sleep-for 1))
(setq file (car file))
(with-temp-buffer
(shell-command
(format "pnmcut -left 110 -top 30 -width 144 -height 144 '%s' | ppmnorm 2>%s | pnmscale -width 48 | ppmtopgm | pgmtopbm -threshold -value 0.92 | pbmtoxbm | compface"
file null-device)
(current-buffer))
(delete-file file)
(buffer-string))))
(defun gnus-grab-cam-face ()
"Grab a picture off the camera and make it into an X-Face."
(shell-command "xawtv-remote snap ppm")
(let ((file nil)
(tempfile (make-temp-file "gnus-face-" nil ".ppm"))
result)
(while (null (setq file (directory-files "/tftpboot/sparky/tmp"
t "snap.*ppm")))
(sleep-for 1))
(setq file (car file))
(shell-command
(format "pnmcut -left 110 -top 30 -width 144 -height 144 '%s' | pnmscale -width 48 -height 48 | ppmtopgm >> %s"
file tempfile))
(let ((gnus-convert-image-to-face-command
(format "cat '%%s' | ppmquant %%d | ppmchange %s | pnmtopng"
(gnus-fun-ppm-change-string))))
(setq result (gnus-face-from-file tempfile)))
(delete-file file)
result))
(defun gnus-fun-ppm-change-string ()
(let* ((possibilities '("%02x0000" "00%02x00" "0000%02x"
"%02x%02x00" "00%02x%02x" "%02x00%02x"))
(format (concat "'#%02x%02x%02x' '#"
(seq-random-elt possibilities)
"'"))
(values nil))
(dotimes (i 255)
(push (format format i i i i i i)
values))
(mapconcat #'identity values " ")))
(defun gnus-funcall-no-warning (function &rest args)
(when (fboundp function)
(apply function args)))
(provide 'gnus-fun)
;;; gnus-fun.el ends here