Merge from emacs--devo--0
[gnus] / lisp / gnus-fun.el
1 ;;; gnus-fun.el --- various frivolous extension functions to Gnus
2
3 ;; Copyright (C) 2002, 2003, 2004, 2005, 2006, 2007 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, or (at your option)
13 ;; 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; see the file COPYING.  If not, write to the
22 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
23 ;; Boston, MA 02110-1301, USA.
24
25 ;;; Commentary:
26
27 ;;; Code:
28
29 ;; For Emacs < 22.2.
30 (eval-and-compile
31   (unless (fboundp 'declare-function) (defmacro declare-function (&rest r))))
32
33 (eval-when-compile
34   (require 'cl))
35
36 (require 'mm-util)
37 (require 'gnus-ems)
38 (require 'gnus-util)
39 (require 'gnus)
40
41 (defvar gnus-face-properties-alist)
42
43 (defcustom gnus-x-face-directory (expand-file-name "x-faces" gnus-directory)
44   "*Directory where X-Face PBM files are stored."
45   :version "22.1"
46   :group 'gnus-fun
47   :type 'directory)
48
49 (defcustom gnus-convert-pbm-to-x-face-command "pbmtoxbm %s | compface"
50   "Command for converting a PBM to an X-Face."
51   :version "22.1"
52   :group 'gnus-fun
53   :type 'string)
54
55 (defcustom gnus-convert-image-to-x-face-command
56   "convert -scale 48x48! %s xbm:- | xbm2xface.pl"
57   "Command for converting an image to an X-Face.
58 The command must take a image filename (use \"%s\") as input.
59 The output must be the Face header data on stdout in PNG format.
60
61 By default it takes a GIF filename and output the X-Face header data
62 on stdout."
63   :version "22.1"
64   :group 'gnus-fun
65   :type '(choice (const :tag "giftopnm, netpbm (GIF input only)"
66                         "giftopnm %s | ppmnorm | pnmscale -width 48 -height 48 | ppmtopgm | pgmtopbm | pbmtoxbm | compface")
67                  (const :tag "convert"
68                         "convert -scale 48x48! %s xbm:- | xbm2xface.pl")
69                  (string)))
70
71 (defcustom gnus-convert-image-to-face-command
72   "convert -scale 48x48! %s -colors %d png:-"
73   "Command for converting an image to a Face.
74
75 The command must take an image filename (first format argument
76 \"%s\") and the number of colors (second format argument: \"%d\")
77 as input.  The output must be the Face header data on stdout in
78 PNG format."
79   :version "22.1"
80   :group 'gnus-fun
81   :type '(choice (const :tag "djpeg, netpbm (JPG input only)"
82                         "djpeg %s | ppmnorm | pnmscale -width 48 -height 48 | ppmquant %d | pnmtopng")
83                  (const :tag "convert"
84                         "convert -scale 48x48! %s -colors %d png:-")
85                  (string)))
86
87 (defun gnus-shell-command-to-string (command)
88   "Like `shell-command-to-string' except not mingling ERROR."
89   (with-output-to-string
90     (call-process shell-file-name nil (list standard-output nil)
91                   nil shell-command-switch command)))
92
93 (defun gnus-shell-command-on-region (start end command)
94   "A simplified `shell-command-on-region'.
95 Output to the current buffer, replace text, and don't mingle error."
96   (call-process-region start end shell-file-name t
97                        (list (current-buffer) nil)
98                        nil shell-command-switch command))
99
100 ;;;###autoload
101 (defun gnus-random-x-face ()
102   "Return X-Face header data chosen randomly from `gnus-x-face-directory'."
103   (interactive)
104   (when (file-exists-p gnus-x-face-directory)
105     (let* ((files (directory-files gnus-x-face-directory t "\\.pbm$"))
106            (file (nth (random (length files)) files)))
107       (when file
108         (gnus-shell-command-to-string
109          (format gnus-convert-pbm-to-x-face-command
110                  (shell-quote-argument file)))))))
111
112 (autoload 'message-goto-eoh "message" nil t)
113
114 ;;;###autoload
115 (defun gnus-insert-random-x-face-header ()
116   "Insert a random X-Face header from `gnus-x-face-directory'."
117   (interactive)
118   (let ((data (gnus-random-x-face)))
119     (save-excursion
120       (message-goto-eoh)
121       (if data
122           (insert "X-Face: " data)
123         (message
124          "No face returned by `gnus-random-x-face'.  Does %s/*.pbm exist?"
125          gnus-x-face-directory)))))
126
127 ;;;###autoload
128 (defun gnus-x-face-from-file (file)
129   "Insert an X-Face header based on an image file.
130
131 Depending on `gnus-convert-image-to-x-face-command' it may accept
132 different input formats."
133   (interactive "fImage file name: ")
134   (when (file-exists-p file)
135     (gnus-shell-command-to-string
136      (format gnus-convert-image-to-x-face-command
137              (shell-quote-argument (expand-file-name file))))))
138
139 ;;;###autoload
140 (defun gnus-face-from-file (file)
141   "Return a Face header based on an image file.
142
143 Depending on `gnus-convert-image-to-face-command' it may accept
144 different input formats."
145   (interactive "fImage file name: ")
146   (when (file-exists-p file)
147     (let ((done nil)
148           (attempt "")
149           (quant 16))
150       (while (and (not done)
151                   (> quant 1))
152         (setq attempt
153               (let ((coding-system-for-read 'binary))
154                 (gnus-shell-command-to-string
155                  (format gnus-convert-image-to-face-command
156                          (shell-quote-argument (expand-file-name file))
157                          quant))))
158         (if (> (length attempt) 726)
159             (progn
160               (setq quant (- quant (if (< quant 10) 1 2)))
161               (gnus-message 9 "Length %d; trying quant %d"
162                             (length attempt) quant))
163           (setq done t)))
164       (if done
165           (mm-with-unibyte-buffer
166             (insert attempt)
167             (gnus-face-encode))
168         nil))))
169
170 (defun gnus-face-encode ()
171   (let ((step 72))
172     (base64-encode-region (point-min) (point-max))
173     (goto-char (point-min))
174     (while (search-forward "\n" nil t)
175       (replace-match ""))
176     (goto-char (point-min))
177     (while (> (- (point-max) (point))
178               step)
179       (forward-char step)
180       (insert "\n ")
181       (setq step 76))
182     (buffer-string)))
183
184 ;;;###autoload
185 (defun gnus-convert-face-to-png (face)
186   "Convert FACE (which is base64-encoded) to a PNG.
187 The PNG is returned as a string."
188   (mm-with-unibyte-buffer
189     (insert face)
190     (ignore-errors
191       (base64-decode-region (point-min) (point-max)))
192     (buffer-string)))
193
194 ;;;###autoload
195 (defun gnus-convert-png-to-face (file)
196   "Convert FILE to a Face.
197 FILE should be a PNG file that's 48x48 and smaller than or equal to
198 726 bytes."
199   (mm-with-unibyte-buffer
200     (insert-file-contents file)
201     (when (> (buffer-size) 726)
202       (error "The file is %d bytes long, which is too long"
203              (buffer-size)))
204     (gnus-face-encode)))
205
206 (defface gnus-x-face '((t (:foreground "black" :background "white")))
207   "Face to show X-Face.
208 The colors from this face are used as the foreground and background
209 colors of the displayed X-Faces."
210   :group 'gnus-article-headers)
211
212 (declare-function article-narrow-to-head   "gnus-art" ())
213 (declare-function gnus-article-goto-header "gnus-art" (header))
214 (declare-function gnus-add-image           "gnus-art" (category image))
215 (declare-function gnus-add-wash-type       "gnus-art" (type))
216
217 (defun gnus-display-x-face-in-from (data)
218   "Display the X-Face DATA in the From header."
219   (require 'gnus-art)
220   (let ((default-enable-multibyte-characters nil)
221         pbm)
222     (when (or (gnus-image-type-available-p 'xface)
223               (and (gnus-image-type-available-p 'pbm)
224                    (setq pbm (uncompface data))))
225       (save-excursion
226         (save-restriction
227           (article-narrow-to-head)
228           (gnus-article-goto-header "from")
229           (when (bobp)
230             (insert "From: [no `from' set]\n")
231             (forward-char -17))
232           (gnus-add-image
233            'xface
234            (gnus-put-image
235             (if (gnus-image-type-available-p 'xface)
236                 (apply 'gnus-create-image (concat "X-Face: " data) 'xface t
237                        (cdr (assq 'xface gnus-face-properties-alist)))
238               (apply 'gnus-create-image pbm 'pbm t
239                      (cdr (assq 'pbm gnus-face-properties-alist))))
240             nil 'xface))
241           (gnus-add-wash-type 'xface))))))
242
243 (defun gnus-grab-cam-x-face ()
244   "Grab a picture off the camera and make it into an X-Face."
245   (interactive)
246   (shell-command "xawtv-remote snap ppm")
247   (let ((file nil))
248     (while (null (setq file (directory-files "/tftpboot/sparky/tmp"
249                                              t "snap.*ppm")))
250       (sleep-for 1))
251     (setq file (car file))
252     (with-temp-buffer
253       (shell-command
254        (format "pnmcut -left 110 -top 30 -width 144 -height 144 '%s' | ppmnorm 2>/dev/null | pnmscale -width 48 | ppmtopgm | pgmtopbm -threshold -value 0.92 | pbmtoxbm | compface"
255                file)
256        (current-buffer))
257       ;;(sleep-for 3)
258       (delete-file file)
259       (buffer-string))))
260
261 (defun gnus-grab-cam-face ()
262   "Grab a picture off the camera and make it into an X-Face."
263   (interactive)
264   (shell-command "xawtv-remote snap ppm")
265   (let ((file nil)
266         result)
267     (while (null (setq file (directory-files "/tftpboot/sparky/tmp"
268                                              t "snap.*ppm")))
269       (sleep-for 1))
270     (setq file (car file))
271     (shell-command
272      (format "pnmcut -left 110 -top 30 -width 144 -height 144 '%s' | pnmscale -width 48 -height 48 | ppmtopgm > /tmp/gnus.face.ppm"
273              file))
274     (let ((gnus-convert-image-to-face-command
275            (format "cat '%%s' | ppmquant %%d | ppmchange %s | pnmtopng"
276                    (gnus-fun-ppm-change-string))))
277       (setq result (gnus-face-from-file "/tmp/gnus.face.ppm")))
278     (delete-file file)
279     ;;(delete-file "/tmp/gnus.face.ppm")
280     result))
281
282 (defun gnus-fun-ppm-change-string ()
283   (let* ((possibilites '("%02x0000" "00%02x00" "0000%02x"
284                         "%02x%02x00" "00%02x%02x" "%02x00%02x"))
285          (format (concat "'#%02x%02x%02x' '#"
286                          (nth (random 6) possibilites)
287                          "'"))
288          (values nil))
289   (dotimes (i 255)
290     (push (format format i i i i i i)
291           values))
292   (mapconcat 'identity values " ")))
293
294 (provide 'gnus-fun)
295
296 ;;; arch-tag: 9d000a69-15cc-4491-9dc0-4627484f50c1
297 ;;; gnus-fun.el ends here