1 ;;; mm-url.el --- a wrapper of url functions/commands for Gnus
3 ;; Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007 Free Software Foundation, Inc.
5 ;; Author: Shenghuo Zhu <zsh@cs.rochester.edu>
7 ;; This file is part of GNU Emacs.
9 ;; GNU Emacs is free software; you can redistribute it and/or modify
10 ;; it under the terms of the GNU General Public License as published
11 ;; by the Free Software Foundation; either version 3, or (at your
12 ;; option) any later version.
14 ;; GNU Emacs is distributed in the hope that it will be useful, but
15 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 ;; General Public License for more details.
19 ;; You should have received a copy of the GNU General Public License
20 ;; along with GNU Emacs; see the file COPYING. If not, write to the
21 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
22 ;; Boston, MA 02110-1301, USA.
26 ;; Some codes are stolen from w3 and url packages. Some are moved from
29 ;; TODO: Support POST, cookie.
33 (eval-when-compile (require 'cl))
38 (defvar url-current-object)
39 (defvar url-package-name)
40 (defvar url-package-version)
43 "A wrapper of url package and external url command for Gnus."
46 (defcustom mm-url-use-external (not
50 "*If non-nil, use external grab program `mm-url-program'."
55 (defvar mm-url-predefined-programs
56 '((wget "wget" "--user-agent=mm-url" "-q" "-O" "-")
57 (w3m "w3m" "-dump_source")
58 (lynx "lynx" "-source")
59 (curl "curl" "--silent" "--user-agent" "mm-url" "--location")))
61 (defcustom mm-url-program
63 ((executable-find "wget") 'wget)
64 ((executable-find "w3m") 'w3m)
65 ((executable-find "lynx") 'lynx)
66 ((executable-find "curl") 'curl)
68 "The url grab program.
69 Likely values are `wget', `w3m', `lynx' and `curl'."
72 (symbol :tag "wget" wget)
73 (symbol :tag "w3m" w3m)
74 (symbol :tag "lynx" lynx)
75 (symbol :tag "curl" curl)
76 (string :tag "other"))
79 (defcustom mm-url-arguments nil
80 "The arguments for `mm-url-program'."
82 :type '(repeat string)
86 ;;; Internal variables
88 (defvar mm-url-package-name
89 (gnus-replace-in-string
90 (gnus-replace-in-string gnus-version " v.*$" "")
93 (defvar mm-url-package-version gnus-version-number)
96 (defvar mm-url-html-entities
104 (rsquo . 39) ; should be U+8217
121 (uarr . 94) ; should be U+8593
123 (lsquo . 96) ; should be U+8216
225 ;; Special handling of these
239 ;; The following 5 entities are not mentioned in the HTML 2.0
240 ;; standard, nor in any other HTML proposed standard of which I
241 ;; am aware. I am not even sure they are ISO entity names. ***
242 ;; Hence, some arrangement should be made to give a bad HTML
243 ;; message when they are seen.
255 ;; (shy . ????) ; soft hyphen
257 "*An assoc list of entity names and how to actually display them.")
259 (defconst mm-url-unreserved-chars
261 ?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
262 ?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
263 ?0 ?1 ?2 ?3 ?4 ?5 ?6 ?7 ?8 ?9
264 ?- ?_ ?. ?! ?~ ?* ?' ?\( ?\))
265 "A list of characters that are _NOT_ reserved in the URL spec.
266 This is taken from RFC 2396.")
268 (defun mm-url-load-url ()
269 "Load `url-insert-file-contents'."
270 (unless (condition-case ()
272 (require 'url-handlers)
276 ;; w3-4.0pre0.46 or earlier version.
281 (defun mm-url-insert-file-contents (url)
282 "Insert file contents of URL.
283 If `mm-url-use-external' is non-nil, use `mm-url-program'."
284 (if mm-url-use-external
286 (if (string-match "^file:/+" url)
287 (insert-file-contents (substring url (1- (match-end 0))))
288 (mm-url-insert-file-contents-external url))
289 (goto-char (point-min))
290 (if (fboundp 'url-generic-parse-url)
291 (setq url-current-object
292 (url-generic-parse-url url)))
293 (list url (buffer-size)))
295 (let ((name buffer-file-name)
296 (url-request-extra-headers
297 ;; ISTM setting a Connection header was a workaround for
298 ;; older versions of url included with w3, but it does more
299 ;; harm than good with the one shipped with Emacs. --ansel
300 (if (not (and (boundp 'url-version)
301 (equal url-version "Emacs")))
302 (list (cons "Connection" "Close"))))
303 (url-package-name (or mm-url-package-name
305 (url-package-version (or mm-url-package-version
306 url-package-version))
308 (setq result (url-insert-file-contents url))
310 (goto-char (point-min))
311 (while (re-search-forward "\r 1000\r ?" nil t)
313 (setq buffer-file-name name)
314 (if (and (fboundp 'url-generic-parse-url)
316 (setq url-current-object (url-generic-parse-url
321 (defun mm-url-insert-file-contents-external (url)
322 "Insert file contents of URL using `mm-url-program'."
324 (if (symbolp mm-url-program)
325 (let ((item (cdr (assq mm-url-program mm-url-predefined-programs))))
326 (setq program (car item)
327 args (append (cdr item) (list url))))
328 (setq program mm-url-program
329 args (append mm-url-arguments (list url))))
330 (unless (eq 0 (apply 'call-process program nil t nil args))
331 (error "Couldn't fetch %s" url))))
333 (defvar mm-url-timeout 30
334 "The number of seconds before timing out an URL fetch.")
336 (defvar mm-url-retries 10
337 "The number of retries after timing out when fetching an URL.")
339 (defun mm-url-insert (url &optional follow-refresh)
340 "Insert the contents from an URL in the current buffer.
341 If FOLLOW-REFRESH is non-nil, redirect refresh url in META."
342 (let ((times mm-url-retries)
346 (while (and (not (zerop (decf times)))
348 (with-timeout (mm-url-timeout)
350 (message "Trying again (%s)..." (- mm-url-retries times)))
354 (narrow-to-region (point) (point))
355 (mm-url-insert-file-contents url)
356 (goto-char (point-min))
357 (when (re-search-forward
358 "<meta[ \t\r\n]*http-equiv=\"Refresh\"[^>]*URL=\\([^\"]+\\)\"" nil t)
359 (let ((url (match-string 1)))
360 (delete-region (point-min) (point-max))
361 (setq result (mm-url-insert url t)))))
362 (setq result (mm-url-insert-file-contents url)))
366 (defun mm-url-decode-entities ()
367 "Decode all HTML entities."
368 (goto-char (point-min))
369 (while (re-search-forward "&\\(#[0-9]+\\|[a-z]+[0-9]*\\);" nil t)
370 (let ((elem (if (eq (aref (match-string 1) 0) ?\#)
372 (string-to-number (substring
373 (match-string 1) 1))))
374 (if (mm-char-or-char-int-p c) c 32))
375 (or (cdr (assq (intern (match-string 1))
376 mm-url-html-entities))
378 (unless (stringp elem)
379 (setq elem (char-to-string elem)))
380 (replace-match elem t t))))
382 (defun mm-url-decode-entities-nbsp ()
383 "Decode all HTML entities and to a space."
384 (let ((mm-url-html-entities (cons '(nbsp . 32) mm-url-html-entities)))
385 (mm-url-decode-entities)))
387 (defun mm-url-decode-entities-string (string)
390 (mm-url-decode-entities)
393 (defun mm-url-form-encode-xwfu (chunk)
394 "Escape characters in a string for application/x-www-form-urlencoded.
395 Blasphemous crap because someone didn't think %20 was good enough for encoding
396 spaces. Die Die Die."
397 ;; This will get rid of the 'attributes' specified by the file type,
398 ;; which are useless for an application/x-www-form-urlencoded form.
400 (setq chunk (cdr chunk)))
406 ((memq char mm-url-unreserved-chars) (char-to-string char))
407 (t (upcase (format "%%%02x" char)))))
408 ;; Fixme: Should this actually be accepting multibyte? Is there a
409 ;; better way in XEmacs?
411 (encode-coding-string chunk
412 (if (fboundp 'find-coding-systems-string)
413 (car (find-coding-systems-string chunk))
414 buffer-file-coding-system))
418 (defun mm-url-encode-www-form-urlencoded (pairs)
419 "Return PAIRS encoded for forms."
422 (concat (mm-url-form-encode-xwfu (car data)) "="
423 (mm-url-form-encode-xwfu (cdr data))))
426 (defun mm-url-fetch-form (url pairs)
427 "Fetch a form from URL with PAIRS as the data using the POST method."
429 (let ((url-request-data (mm-url-encode-www-form-urlencoded pairs))
430 (url-request-method "POST")
431 (url-request-extra-headers
432 '(("Content-type" . "application/x-www-form-urlencoded"))))
433 (url-insert-file-contents url)
434 (setq buffer-file-name nil))
437 (defun mm-url-fetch-simple (url content)
439 (let ((url-request-data content)
440 (url-request-method "POST")
441 (url-request-extra-headers
442 '(("Content-type" . "application/x-www-form-urlencoded"))))
443 (url-insert-file-contents url)
444 (setq buffer-file-name nil))
447 (defun mm-url-remove-markup ()
448 "Remove all HTML markup, leaving just plain text."
449 (goto-char (point-min))
450 (while (search-forward "<!--" nil t)
451 (delete-region (match-beginning 0)
452 (or (search-forward "-->" nil t)
454 (goto-char (point-min))
455 (while (re-search-forward "<[^>]+>" nil t)
456 (replace-match "" t t)))
460 ;;; arch-tag: 0594f9b3-417c-48b0-adc2-5082e1e7917f
461 ;;; mm-url.el ends here