lisp/gnus/mm-url.el

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