cgit.sxemacs.org Git - gnus/blob - lisp/gnus-fun.el

   1 ;;; gnus-fun.el --- various frivolous extension functions to Gnus
   2
   3 ;; Copyright (C) 2002-2012 Free Software Foundation, Inc.
   4
   5 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
   6 ;; Keywords: news
   7
   8 ;; This file is part of GNU Emacs.
   9
  10 ;; GNU Emacs is free software: you can redistribute it and/or modify
  11 ;; it under the terms of the GNU General Public License as published by
  12 ;; the Free Software Foundation, either version 3 of the License, or
  13 ;; (at your option) any later version.
  14
  15 ;; GNU Emacs is distributed in the hope that it will be useful,
  16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18 ;; GNU General Public License for more details.
  19
  20 ;; You should have received a copy of the GNU General Public License
  21 ;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
  22
  23 ;;; Commentary:
  24
  25 ;;; Code:
  26
  27 ;; For Emacs <22.2 and XEmacs.
  28 (eval-and-compile
  29   (unless (fboundp 'declare-function) (defmacro declare-function (&rest r))))
  30
  31 (eval-when-compile
  32   (require 'cl))
  33
  34 (require 'mm-util)
  35 (require 'gnus-ems)
  36 (require 'gnus-util)
  37 (require 'gnus)
  38
  39 (defvar gnus-face-properties-alist)
  40
  41 (defcustom gnus-x-face-directory (expand-file-name "x-faces" gnus-directory)
  42   "*Directory where X-Face PBM files are stored."
  43   :version "22.1"
  44   :group 'gnus-fun
  45   :type 'directory)
  46
  47 (defcustom gnus-convert-pbm-to-x-face-command "pbmtoxbm %s | compface"
  48   "Command for converting a PBM to an X-Face."
  49   :version "22.1"
  50   :group 'gnus-fun
  51   :type 'string)
  52
  53 (defcustom gnus-convert-image-to-x-face-command
  54   "convert -scale 48x48! %s xbm:- | xbm2xface.pl"
  55   "Command for converting an image to an X-Face.
  56 The command must take a image filename (use \"%s\") as input.
  57 The output must be the X-Face header data on stdout."
  58   :version "22.1"
  59   :group 'gnus-fun
  60   :type '(choice (const :tag "giftopnm, netpbm (GIF input only)"
  61                         "giftopnm %s | ppmnorm | pnmscale -width 48 -height 48 | ppmtopgm | pgmtopbm | pbmtoxbm | compface")
  62                  (const :tag "convert"
  63                         "convert -scale 48x48! %s xbm:- | xbm2xface.pl")
  64                  (string)))
  65
  66 (defcustom gnus-convert-image-to-face-command
  67   "convert -scale 48x48! %s -colors %d png:-"
  68   "Command for converting an image to a Face.
  69
  70 The command must take an image filename (first format argument
  71 \"%s\") and the number of colors (second format argument: \"%d\")
  72 as input.  The output must be the Face header data on stdout in
  73 PNG format."
  74   :version "22.1"
  75   :group 'gnus-fun
  76   :type '(choice (const :tag "djpeg, netpbm (JPG input only)"
  77                         "djpeg %s | ppmnorm | pnmscale -width 48 -height 48 | ppmquant %d | pnmtopng")
  78                  (const :tag "convert"
  79                         "convert -scale 48x48! %s -colors %d png:-")
  80                  (string)))
  81
  82 (defun gnus-shell-command-to-string (command)
  83   "Like `shell-command-to-string' except not mingling ERROR."
  84   (with-output-to-string
  85     (call-process shell-file-name nil (list standard-output nil)
  86                   nil shell-command-switch command)))
  87
  88 ;;;###autoload
  89 (defun gnus-random-x-face ()
  90   "Return X-Face header data chosen randomly from `gnus-x-face-directory'."
  91   (interactive)
  92   (when (file-exists-p gnus-x-face-directory)
  93     (let* ((files (directory-files gnus-x-face-directory t "\\.pbm$"))
  94            (file (nth (random (length files)) files)))
  95       (when file
  96         (gnus-shell-command-to-string
  97          (format gnus-convert-pbm-to-x-face-command
  98                  (shell-quote-argument file)))))))
  99
 100 (autoload 'message-goto-eoh "message" nil t)
 101
 102 ;;;###autoload
 103 (defun gnus-insert-random-x-face-header ()
 104   "Insert a random X-Face header from `gnus-x-face-directory'."
 105   (interactive)
 106   (let ((data (gnus-random-x-face)))
 107     (save-excursion
 108       (message-goto-eoh)
 109       (if data
 110           (insert "X-Face: " data)
 111         (message
 112          "No face returned by `gnus-random-x-face'.  Does %s/*.pbm exist?"
 113          gnus-x-face-directory)))))
 114
 115 ;;;###autoload
 116 (defun gnus-x-face-from-file (file)
 117   "Insert an X-Face header based on an image file.
 118
 119 Depending on `gnus-convert-image-to-x-face-command' it may accept
 120 different input formats."
 121   (interactive "fImage file name: ")
 122   (when (file-exists-p file)
 123     (gnus-shell-command-to-string
 124      (format gnus-convert-image-to-x-face-command
 125              (shell-quote-argument (expand-file-name file))))))
 126
 127 ;;;###autoload
 128 (defun gnus-face-from-file (file)
 129   "Return a Face header based on an image file.
 130
 131 Depending on `gnus-convert-image-to-face-command' it may accept
 132 different input formats."
 133   (interactive "fImage file name: ")
 134   (when (file-exists-p file)
 135     (let ((done nil)
 136           (attempt "")
 137           (quant 16))
 138       (while (and (not done)
 139                   (> quant 1))
 140         (setq attempt
 141               (let ((coding-system-for-read 'binary))
 142                 (gnus-shell-command-to-string
 143                  (format gnus-convert-image-to-face-command
 144                          (shell-quote-argument (expand-file-name file))
 145                          quant))))
 146         (if (> (length attempt) 726)
 147             (progn
 148               (setq quant (- quant (if (< quant 10) 1 2)))
 149