1 ;;; mm-url.el --- a wrapper of url functions/commands for Gnus
2 ;; Copyright (C) 2001, 2002, 2003 Free Software Foundation, Inc.
4 ;; Author: Shenghuo Zhu <zsh@cs.rochester.edu>
6 ;; This file is part of GNU Emacs.
8 ;; GNU Emacs is free software; you can redistribute it and/or modify
9 ;; it under the terms of the GNU General Public License as published
10 ;; by the Free Software Foundation; either version 2, or (at your
11 ;; option) any later version.
13 ;; GNU Emacs is distributed in the hope that it will be useful, but
14 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
15 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 ;; General Public License for more details.
18 ;; You should have received a copy of the GNU General Public License
19 ;; along with GNU Emacs; see the file COPYING. If not, write to the
20 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21 ;; Boston, MA 02111-1307, USA.
25 ;; Some codes are stolen from w3 and url packages. Some are moved from
28 ;; TODO: Support POST, cookie.
32 (eval-when-compile (require 'cl))
38 (autoload 'executable-find "executable"))
41 "A wrapper of url package and external url command for Gnus."
44 (defcustom mm-url-use-external (not
48 "*If not-nil, use external grab program `mm-url-program'."
52 (defvar mm-url-predefined-programs
53 '((wget "wget" "-q" "-O" "-")
54 (w3m "w3m" "-dump_source")
55 (lynx "lynx" "-source")
58 (defcustom mm-url-program
60 ((executable-find "wget") 'wget)
61 ((executable-find "w3m") 'w3m)
62 ((executable-find "lynx") 'lynx)
63 ((executable-find "curl") 'curl)
65 "The url grab program.
66 Likely values are `wget', `w3m', `lynx' and `curl'."
68 (symbol :tag "wget" wget)
69 (symbol :tag "w3m" w3m)
70 (symbol :tag "lynx" lynx)
71 (symbol :tag "curl" curl)
72 (string :tag "other"))
75 (defcustom mm-url-arguments nil
76 "The arguments for `mm-url-program'."
77 :type '(repeat string)
81 ;;; Internal variables
83 (defvar mm-url-package-name
84 (gnus-replace-in-string
85 (gnus-replace-in-string gnus-version " v.*$" "")
88 (defvar mm-url-package-version gnus-version-number)
91 (defvar mm-url-html-entities
99 (rsquo . 39) ; should be U+8217
116 (uarr . 94) ; should be U+8593
118 (lsquo . 96) ; should be U+8216
220 ;; Special handling of these
234 ;; The following 5 entities are not mentioned in the HTML 2.0
235 ;; standard, nor in any other HTML proposed standard of which I
236 ;; am aware. I am not even sure they are ISO entity names. ***
237 ;; Hence, some arrangement should be made to give a bad HTML
238 ;; message when they are seen.
250 ;; (shy . ????) ; soft hyphen
252 "*An assoc list of entity names and how to actually display them.")
254 (defconst mm-url-unreserved-chars
256 ?a ?b ?c ?d ?e ?f ?g ?h ?i ?j ?k ?l ?m ?n ?o ?p ?q ?r ?s ?t ?u ?v ?w ?x ?y ?z
257 ?A ?B ?C ?D ?E ?F ?G ?H ?I ?J ?K ?L ?M ?N ?O ?P ?Q ?R ?S ?T ?U ?V ?W ?X ?Y ?Z
258 ?0 ?1 ?2 ?3 ?4 ?5 ?6 ?7 ?8 ?9
259 ?- ?_ ?. ?! ?~ ?* ?' ?\( ?\))
260 "A list of characters that are _NOT_ reserved in the URL spec.
261 This is taken from RFC 2396.")
263 (defun mm-url-load-url ()
264 "Load `url-insert-file-contents'."
265 (unless (condition-case ()
266 (require 'url-handlers)
268 ;; w3-4.0pre0.46 or earlier version.
272 (defun mm-url-insert-file-contents (url)
273 (if mm-url-use-external
275 (if (string-match "^file:/+" url)
276 (insert-file-contents (substring url (1- (match-end 0))))
277 (mm-url-insert-file-contents-external url))
278 (goto-char (point-min))
279 (list url (buffer-size)))
281 (let ((name buffer-file-name)
282 (url-package-name (or mm-url-package-name
284 (url-package-version (or mm-url-package-version
285 url-package-version)))
287 (url-insert-file-contents url)
289 (goto-char (point-min))
290 (while (re-search-forward "\r 1000\r ?" nil t)
292 (setq buffer-file-name name)))))
294 (defun mm-url-insert-file-contents-external (url)
296 (if (symbolp mm-url-program)
297 (let ((item (cdr (assq mm-url-program mm-url-predefined-programs))))
298 (setq program (car item)
299 args (append (cdr item) (list url))))
300 (setq program mm-url-program
301 args (append mm-url-arguments (list url))))
302 (apply 'call-process program nil t nil args)))
304 (defvar mm-url-timeout 30
305 "The number of seconds before timing out an URL fetch.")
307 (defvar mm-url-retries 10
308 "The number of retries after timing out when fetching an URL.")
310 (defun mm-url-insert (url &optional follow-refresh)
311 "Insert the contents from an URL in the current buffer.
312 If FOLLOW-REFRESH is non-nil, redirect refresh url in META."
313 (let ((times mm-url-retries)
317 (while (and (not (zerop (decf times)))
319 (with-timeout (mm-url-timeout)
321 (message "Trying again (%s)..." (- mm-url-retries times)))
325 (narrow-to-region (point) (point))
326 (mm-url-insert-file-contents url)
327 (goto-char (point-min))
328 (when (re-search-forward
329 "<meta[ \t\r\n]*http-equiv=\"Refresh\"[^>]*URL=\\([^\"]+\\)\"" nil t)
330 (let ((url (match-string 1)))
331 (delete-region (point-min) (point-max))
332 (setq result (mm-url-insert url t)))))
333 (setq result (mm-url-insert-file-contents url)))
337 (defun mm-url-decode-entities ()
338 "Decode all HTML entities."
339 (goto-char (point-min))
340 (while (re-search-forward "&\\(#[0-9]+\\|[a-z]+\\);" nil t)
341 (let ((elem (if (eq (aref (match-string 1) 0) ?\#)
343 (string-to-number (substring
344 (match-string 1) 1))))
345 (if (mm-char-or-char-int-p c) c 32))
346 (or (cdr (assq (intern (match-string 1))
347 mm-url-html-entities))
349 (unless (stringp elem)
350 (setq elem (char-to-string elem)))
351 (replace-match elem t t))))
353 (defun mm-url-decode-entities-nbsp ()
354 "Decode all HTML entities and to a space."
355 (let ((mm-url-html-entities (cons '(nbsp . 32) mm-url-html-entities)))
356 (mm-url-decode-entities)))
358 (defun mm-url-decode-entities-string (string)
361 (mm-url-decode-entities)
362 (buffer-substring (point-min) (point-max))))
364 (defun mm-url-form-encode-xwfu (chunk)
365 "Escape characters in a string for application/x-www-form-urlencoded.
366 Blasphemous crap because someone didn't think %20 was good enough for encoding
367 spaces. Die Die Die."
368 ;; This will get rid of the 'attributes' specified by the file type,
369 ;; which are useless for an application/x-www-form-urlencoded form.
371 (setq chunk (cdr chunk)))
377 ((memq char mm-url-unreserved-chars) (char-to-string char))
378 (t (upcase (format "%%%02x" char)))))
379 ;; Fixme: Should this actually be accepting multibyte? Is there a
380 ;; better way in XEmacs?
382 (encode-coding-string chunk
383 (if (fboundp 'find-coding-systems-string)
384 (car (find-coding-systems-string chunk))
385 buffer-file-coding-system))
389 (defun mm-url-encode-www-form-urlencoded (pairs)
390 "Return PAIRS encoded for forms."
393 (concat (mm-url-form-encode-xwfu (car data)) "="
394 (mm-url-form-encode-xwfu (cdr data))))
397 (defun mm-url-fetch-form (url pairs)
398 "Fetch a form from URL with PAIRS as the data using the POST method."
400 (let ((url-request-data (mm-url-encode-www-form-urlencoded pairs))
401 (url-request-method "POST")
402 (url-request-extra-headers
403 '(("Content-type" . "application/x-www-form-urlencoded"))))
404 (url-insert-file-contents url)
405 (setq buffer-file-name nil))
408 (defun mm-url-fetch-simple (url content)
410 (let ((url-request-data content)
411 (url-request-method "POST")
412 (url-request-extra-headers
413 '(("Content-type" . "application/x-www-form-urlencoded"))))
414 (url-insert-file-contents url)
415 (setq buffer-file-name nil))
418 (defun mm-url-remove-markup ()
419 "Remove all HTML markup, leaving just plain text."
420 (goto-char (point-min))
421 (while (search-forward "<!--" nil t)
422 (delete-region (match-beginning 0)
423 (or (search-forward "-->" nil t)
425 (goto-char (point-min))
426 (while (re-search-forward "<[^>]+>" nil t)
427 (replace-match "" t t)))
431 ;;; mm-url.el ends here