cgit.sxemacs.org Git - gnus/blob - lisp/mm-url.el

   1 ;;; mm-url.el --- a wrapper of url functions/commands for Gnus
   2 ;; Copyright (C) 2001, 2002, 2003, 2004 Free Software Foundation, Inc.
   3
   4 ;; Author: Shenghuo Zhu <zsh@cs.rochester.edu>
   5
   6 ;; This file is part of GNU Emacs.
   7
   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.
  12
  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.
  17
  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.
  22
  23 ;;; Commentary:
  24
  25 ;; Some codes are stolen from w3 and url packages. Some are moved from
  26 ;; nnweb.
  27
  28 ;; TODO: Support POST, cookie.
  29
  30 ;;; Code:
  31
  32 (eval-when-compile (require 'cl))
  33
  34 (require 'mm-util)
  35 (require 'gnus)
  36
  37 (eval-when-compile
  38   (require 'timer))
  39
  40 (defgroup mm-url nil
  41   "A wrapper of url package and external url command for Gnus."
  42   :group 'gnus)
  43
  44 (defcustom mm-url-use-external (not
  45                                 (condition-case nil
  46                                     (require 'url)
  47                                   (error nil)))
  48   "*If non-nil, use external grab program `mm-url-program'."
  49   :type 'boolean
  50   :group 'mm-url)
  51
  52 (defvar mm-url-predefined-programs
  53   '((wget "wget" "--user-agent=mm-url" "-q" "-O" "-")
  54     (w3m  "w3m" "-dump_source")
  55     (lynx "lynx" "-source")
  56     (curl "curl")))
  57
  58 (defcustom mm-url-program
  59   (cond
  60    ((executable-find "wget") 'wget)
  61    ((executable-find "w3m") 'w3m)
  62    ((executable-find "lynx") 'lynx)
  63    ((executable-find "curl") 'curl)
  64    (t "GET"))
  65   "The url grab program.
  66 Likely values are `wget', `w3m', `lynx' and `curl'."
  67   :type '(choice
  68           (symbol :tag "wget" wget)
  69           (symbol :tag "w3m" w3m)
  70           (symbol :tag "lynx" lynx)
  71           (symbol :tag "curl" curl)
  72           (string :tag "other"))
  73   :group 'mm-url)
  74
  75 (defcustom mm-url-arguments nil
  76   "The arguments for `mm-url-program'."
  77   :type '(repeat string)
  78   :group 'mm-url)
  79
  80 \f
  81 ;;; Internal variables
  82
  83 (defvar mm-url-package-name
  84   (gnus-replace-in-string
  85    (gnus-replace-in-string gnus-version " v.*$" "")
  86    " " "-"))
  87
  88 (defvar mm-url-package-version gnus-version-number)
  89
  90 ;; Stolen from w3.
  91 (defvar mm-url-html-entities
  92   '(
  93     ;;(excl        .  33)
  94     (quot        .  34)
  95     ;;(num         .  35)
  96     ;;(dollar      .  36)
  97     ;;(percent     .  37)
  98     (amp         .  38)
  99     (rsquo       .  39)                 ; should be U+8217
 100     ;;(apos        .  39)
 101     ;;(lpar        .  40)
 102     ;;(rpar        .  41)
 103     ;;(ast         .  42)
 104     ;;(plus        .  43)
 105     ;;(comma       .  44)
 106     ;;(period      .  46)
 107     ;;(colon       .  58)
 108     ;;(semi        .  59)
 109     (lt          .  60)
 110     ;;(equals      .  61)
 111     (gt          .  62)
 112     ;;(quest       .  63)
 113     ;;(commat      .  64)
 114     ;;(lsqb        .  91)
 115     ;;(rsqb        .  93)
 116     (uarr        .  94)                 ; should be U+8593
 117     ;;(lowbar      .  95)
 118     (lsquo       .  96)                 ; should be U+8216
 119     (lcub        . 123)
 120     ;;(verbar      . 124)
 121     (rcub        . 125)
 122     (tilde       . 126)
 123     (nbsp        . 160)
 124     (iexcl       . 161)
 125     (cent        . 162)
 126     (pound       . 163)
 127     (curren      . 164)
 128     (yen         . 165)
 129     (brvbar      . 166)
 130     (sect        . 167)
 131     (uml         . 168)
 132     (copy        . 169)
 133     (ordf        . 170)
 134     (laquo       . 171)
 135     (not         . 172)
 136     (shy         . 173)
 137     (reg         . 174)
 138     (macr        . 175)
 139     (deg         . 176)
 140     (plusmn      . 177)
 141     (sup2        . 178)
 142     (sup3        . 179)
 143     (acute       . 180)
 144     (micro       . 181)
 145     (para        . 182)
 146     (middot      . 183)
 147     (cedil       . 184)
 148     (sup1        . 185)
 149     (ordm        . 186)
 150     (raquo       . 187)
 151     (frac14      . 188)
 152     (frac12      . 189)
 153     (frac34      . 190)
 154     (iquest      . 191)
 155     (Agrave      . 192)
 156     (Aacute      . 193)
 157     (Acirc       . 194)
 158     (Atilde      . 195)
 159     (Auml        . 196)
 160     (Aring       . 197)
 161     (AElig       . 198)
 162     (Ccedil      . 199)
 163     (Egrave      . 200)
 164     (Eacute      . 201)
 165     (Ecirc       . 202)
 166     (Euml        . 203)
 167     (Igrave      . 204)
 168     (Iacute      . 205)
 169     (Icirc       . 206)
 170     (Iuml        . 207)
 171     (ETH         . 208)
 172     (Ntilde      . 209)
 173     (Ograve      . 210)
 174     (Oacute      . 211)
 175     (Ocirc       . 212)
 176     (Otilde      . 213)
 177     (Ouml        . 214)
 178     (times       . 215)
 179     (Oslash      . 216)
 180     (Ugrave      . 217)
 181     (Uacute      . 218)
 182     (Ucirc       . 219)
 183     (Uuml        . 220)
 184     (Yacute      . 221)
 185     (THORN       . 222)
 186     (szlig       . 223)
 187     (agrave      . 224)
 188     (aacute      . 225)
 189     (acirc       . 226)
 190     (atilde      . 227)
 191     (auml        . 228)
 192     (aring       . 229)
 193     (aelig       . 230)
 194     (ccedil      . 231)
 195     (egrave      . 232)
 196     (eacute      . 233)
 197     (ecirc       . 234)
 198     (euml        . 235)
 199     (igrave      . 236)
 200     (iacute      . 237)
 201     (icirc       . 238)
 202     (iuml        . 239)
 203     (eth         . 240)
 204     (ntilde      . 241)
 205     (ograve      . 242)
 206     (oacute      . 243)
 207     (ocirc       . 244)
 208     (otilde      . 245)
 209     (ouml        . 246)
 210     (divide      . 247)
 211     (oslash      . 248)
 212     (ugrave      . 249)
 213     (uacute      . 250)
 214     (ucirc       . 251)
 215     (uuml        . 252)
 216     (yacute      . 253)
 217     (thorn       . 254)
 218     (yuml        . 255)
 219
 220     ;; Special handling of these
 221     (frac56      . "5/6")
 222     (frac16      . "1/6")
 223     (frac45      . "4/5")
 224     (frac35      . "3/5")
 225     (frac25      . "2/5")
 226     (frac15      . "1/5")
 227     (frac23      . "2/3")
 228     (frac13      . "1/3")
 229     (frac78      . "7/8")
 230     (frac58      . "5/8")
 231     (frac38      . "3/8")
 232     (frac18      . "1/8")
 233
 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.
 239     (ndash       .  45)
 240     (mdash       .  45)
 241     (emsp        .  32)
 242     (ensp        .  32)
 243     (sim         . 126)
 244     (le          . "<=")
 245     (agr         . "alpha")
 246     (rdquo       . "''")
 247     (ldquo       . "``")
 248     (trade       . "(TM)")
 249     ;; To be done
 250     ;; (shy      . ????) ; soft hyphen
 251     )
 252   "*An assoc list of entity names and how to actually display them.")
 253
 254 (defconst mm-url-unreserved-chars
 255   '(
 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.")
 262
 263 (defun mm-url-load-url ()
 264   "Load `url-insert-file-contents'."
 265   (unless (condition-case ()
 266               (require 'url-handlers)
 267             (error nil))
 268     ;; w3-4.0pre0.46 or earlier version.
 269     (require 'w3-vars)
 270     (require 'url)))
 271
 272 ;;;###autoload
 273 (defun mm-url-insert-file-contents (url)
 274   "Insert file contents of URL.
 275 If `mm-url-use-external' is non-nil, use `mm-url-program'."
 276   (if mm-url-use-external
 277       (progn
 278         (if (string-match "^file:/+" url)
 279             (insert-file-contents (substring url (1- (match-end 0))))
 280           (mm-url-insert-file-contents-external url))
 281         (goto-char (point-min))
 282         (if (fboundp 'url-generic-parse-url)
 283             (setq url-current-object
 284                   (url-generic-parse-url url)))
 285         (list url (buffer-size)))
 286     (mm-url-load-url)
 287     (let ((name buffer-file-name)
 288           (url-request-extra-headers (list (cons "Connection" "Close")))
 289           (url-package-name (or mm-url-package-name
 290                                 url-package-name))
 291           (url-package-version (or mm-url-package-version
 292                                    url-package-version))
 293           result)
 294       (setq result (url-insert-file-contents url))
 295       (save-excursion
 296         (goto-char (point-min))
 297         (while (re-search-forward "\r 1000\r ?" nil t)
 298           (replace-match "")))
 299       (setq buffer-file-name name)
 300       (if (and (fboundp 'url-generic-parse-url)
 301                (listp result))
 302           (setq url-current-object (url-generic-parse-url
 303                                     (car result))))
 304       result)))
 305
 306 ;;;###autoload
 307 (defun mm-url-insert-file-contents-external (url)
 308   "Insert file contents of URL using `mm-url-program'."
 309   (let (program args)
 310     (if (symbolp mm-url-program)
 311         (let ((item (cdr (assq mm-url-program mm-url-predefined-programs))))
 312           (setq program (car item)
 313                 args (append (cdr item) (list url))))
 314       (setq program mm-url-program
 315             args (append mm-url-arguments (list url))))
 316     (unless (eq 0 (apply 'call-process program nil t nil args))
 317       (error "Couldn't fetch %s" url))))
 318
 319 (defvar mm-url-timeout 30
 320   "The number of seconds before timing out an URL fetch.")
 321
 322 (defvar mm-url-retries 10
 323   "The number of retries after timing out when fetching an URL.")
 324
 325 (defun mm-url-insert (url &optional follow-refresh)
 326   "Insert the contents from an URL in the current buffer.
 327 If FOLLOW-REFRESH is non-nil, redirect refresh url in META."
 328   (let ((times mm-url-retries)
 329         (done nil)
 330         (first t)
 331         result)
 332     (while (and (not (zerop (decf times)))
 333                 (not done))
 334       (with-timeout (mm-url-timeout)
 335         (unless first
 336           (message "Trying again (%s)..." (- mm-url-retries times)))
 337         (setq first nil)
 338         (if follow-refresh
 339             (save-restriction
 340               (narrow-to-region (point) (point))
 341               (mm-url-insert-file-contents url)
 342               (goto-char (point-min))
 343               (when (re-search-forward
 344                      "<meta[ \t\r\n]*http-equiv=\"Refresh\"[^>]*URL=\\([^\"]+\\)\"" nil t)
 345                 (let ((url (match-string 1)))
 346                   (delete-region (point-min) (point-max))
 347                   (setq result (mm-url-insert url t)))))
 348           (setq result (mm-url-insert-file-contents url)))
 349         (setq done t)))
 350     result))
 351
 352 (defun mm-url-decode-entities ()
 353   "Decode all HTML entities."
 354   (goto-char (point-min))
 355   (while (re-search-forward "&\\(#[0-9]+\\|[a-z]+\\);" nil t)
 356     (let ((elem (if (eq (aref (match-string 1) 0) ?\#)
 357                         (let ((c
 358                                (string-to-number (substring
 359                                                   (match-string 1) 1))))
 360                           (if (mm-char-or-char-int-p c) c 32))
 361                       (or (cdr (assq (intern (match-string 1))
 362                                      mm-url-html-entities))
 363                           ?#))))
 364       (unless (stringp elem)
 365         (setq elem (char-to-string elem)))
 366       (replace-match elem t t))))
 367
 368 (defun mm-url-decode-entities-nbsp ()
 369   "Decode all HTML entities and &nbsp; to a space."
 370   (let ((mm-url-html-entities (cons '(nbsp . 32) mm-url-html-entities)))
 371     (mm-url-decode-entities)))
 372
 373 (defun mm-url-decode-entities-string (string)
 374   (with-temp-buffer
 375     (insert string)
 376     (mm-url-decode-entities)
 377     (buffer-string)))
 378
 379 (defun mm-url-form-encode-xwfu (chunk)
 380   "Escape characters in a string for application/x-www-form-urlencoded.
 381 Blasphemous crap because someone didn't think %20 was good enough for encoding
 382 spaces.  Die Die Die."
 383   ;; This will get rid of the 'attributes' specified by the file type,
 384   ;; which are useless for an application/x-www-form-urlencoded form.
 385   (if (consp chunk)
 386       (setq chunk (cdr chunk)))
 387
 388   (mapconcat
 389    (lambda (char)
 390      (cond
 391       ((= char ?  ) "+")
 392       ((memq char mm-url-unreserved-chars) (char-to-string char))
 393       (t (upcase (format "%%%02x" char)))))
 394    ;; Fixme: Should this actually be accepting multibyte?  Is there a
 395    ;; better way in XEmacs?
 396    (if (featurep 'mule)
 397        (encode-coding-string chunk
 398                              (if (fboundp 'find-coding-systems-string)
 399                                  (car (find-coding-systems-string chunk))
 400                                  buffer-file-coding-system))
 401      chunk)
 402    ""))
 403
 404 (defun mm-url-encode-www-form-urlencoded (pairs)
 405   "Return PAIRS encoded for forms."
 406   (mapconcat
 407    (lambda (data)
 408      (concat (mm-url-form-encode-xwfu (car data)) "="
 409              (mm-url-form-encode-xwfu (cdr data))))
 410    pairs "&"))
 411
 412 (defun mm-url-fetch-form (url pairs)
 413   "Fetch a form from URL with PAIRS as the data using the POST method."
 414   (mm-url-load-url)
 415   (let ((url-request-data (mm-url-encode-www-form-urlencoded pairs))
 416         (url-request-method "POST")
 417         (url-request-extra-headers
 418          '(("Content-type" . "application/x-www-form-urlencoded"))))
 419     (url-insert-file-contents url)
 420     (setq buffer-file-name nil))
 421   t)
 422
 423 (defun mm-url-fetch-simple (url content)
 424   (mm-url-load-url)
 425   (let ((url-request-data content)
 426         (url-request-method "POST")
 427         (url-request-extra-headers
 428          '(("Content-type" . "application/x-www-form-urlencoded"))))
 429     (url-insert-file-contents url)
 430     (setq buffer-file-name nil))
 431   t)
 432
 433 (defun mm-url-remove-markup ()
 434   "Remove all HTML markup, leaving just plain text."
 435   (goto-char (point-min))
 436   (while (search-forward "<!--" nil t)
 437     (delete-region (match-beginning 0)
 438                    (or (search-forward "-->" nil t)
 439                        (point-max))))
 440   (goto-char (point-min))
 441   (while (re-search-forward "<[^>]+>" nil t)
 442     (replace-match "" t t)))
 443
 444 (provide 'mm-url)
 445
 446 ;;; mm-url.el ends here