Update copyright year to 2015
[emacs.git] / lisp / net / eww.el
blob2ce95d97ff8d9190879b85fafad9257aae14c56b
1 ;;; eww.el --- Emacs Web Wowser
3 ;; Copyright (C) 2013-2015 Free Software Foundation, Inc.
5 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
6 ;; Keywords: html
8 ;; This file is part of GNU Emacs.
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 of the License, or
13 ;; (at your option) any later version.
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.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;; Commentary:
25 ;;; Code:
27 (eval-when-compile (require 'cl))
28 (require 'format-spec)
29 (require 'shr)
30 (require 'url)
31 (require 'url-queue)
32 (require 'url-util) ; for url-get-url-at-point
33 (require 'mm-url)
34 (eval-when-compile (require 'subr-x)) ;; for string-trim
36 (defgroup eww nil
37 "Emacs Web Wowser"
38 :version "25.1"
39 :link '(custom-manual "(eww) Top")
40 :group 'web
41 :prefix "eww-")
43 (defcustom eww-header-line-format "%t: %u"
44 "Header line format.
45 - %t is replaced by the title.
46 - %u is replaced by the URL."
47 :version "24.4"
48 :group 'eww
49 :type 'string)
51 (defcustom eww-search-prefix "https://duckduckgo.com/html/?q="
52 "Prefix URL to search engine"
53 :version "24.4"
54 :group 'eww
55 :type 'string)
57 (defcustom eww-download-directory "~/Downloads/"
58 "Directory where files will downloaded."
59 :version "24.4"
60 :group 'eww
61 :type 'string)
63 (defcustom eww-suggest-uris
64 '(eww-links-at-point
65 url-get-url-at-point
66 eww-current-url)
67 "List of functions called to form the list of default URIs for `eww'.
68 Each of the elements is a function returning either a string or a list
69 of strings. The results will be joined into a single list with
70 duplicate entries (if any) removed."
71 :version "25.1"
72 :group 'eww
73 :type 'hook
74 :options '(eww-links-at-point
75 url-get-url-at-point
76 eww-current-url))
78 (defcustom eww-bookmarks-directory user-emacs-directory
79 "Directory where bookmark files will be stored."
80 :version "25.1"
81 :group 'eww
82 :type 'string)
84 (defcustom eww-desktop-remove-duplicates t
85 "Whether to remove duplicates from the history when saving desktop data.
86 If non-nil, repetitive EWW history entries (comprising of the URI, the
87 title, and the point position) will not be saved as part of the Emacs
88 desktop. Otherwise, such entries will be retained."
89 :version "25.1"
90 :group 'eww
91 :type 'boolean)
93 (defcustom eww-restore-desktop nil
94 "How to restore EWW buffers on `desktop-restore'.
95 If t or 'auto, the buffers will be reloaded automatically.
96 If nil, buffers will require manual reload, and will contain the text
97 specified in `eww-restore-reload-prompt' instead of the actual Web
98 page contents."
99 :version "25.1"
100 :group 'eww
101 :type '(choice (const :tag "Restore all automatically" t)
102 (const :tag "Require manual reload" nil)))
104 (defcustom eww-restore-reload-prompt
105 "\n\n *** Use \\[eww-reload] to reload this buffer. ***\n"
106 "The string to put in the buffers not reloaded on `desktop-restore'.
107 This prompt will be used if `eww-restore-desktop' is nil.
109 The string will be passed through `substitute-command-keys'."
110 :version "25.1"
111 :group 'eww
112 :type 'string)
114 (defcustom eww-history-limit 50
115 "Maximum number of entries to retain in the history."
116 :version "25.1"
117 :group 'eww
118 :type '(choice (const :tag "Unlimited" nil)
119 integer))
121 (defcustom eww-use-external-browser-for-content-type
122 "\\`\\(video/\\|audio/\\|application/ogg\\)"
123 "Always use external browser for specified content-type."
124 :version "24.4"
125 :group 'eww
126 :type '(choice (const :tag "Never" nil)
127 regexp))
129 (defcustom eww-after-render-hook nil
130 "A hook called after eww has finished rendering the buffer."
131 :version "25.1"
132 :group 'eww
133 :type 'hook)
135 (defcustom eww-form-checkbox-selected-symbol "[X]"
136 "Symbol used to represent a selected checkbox.
137 See also `eww-form-checkbox-symbol'."
138 :version "24.4"
139 :group 'eww
140 :type '(choice (const "[X]")
141 (const "☒") ; Unicode BALLOT BOX WITH X
142 (const "☑") ; Unicode BALLOT BOX WITH CHECK
143 string))
145 (defcustom eww-form-checkbox-symbol "[ ]"
146 "Symbol used to represent a checkbox.
147 See also `eww-form-checkbox-selected-symbol'."
148 :version "24.4"
149 :group 'eww
150 :type '(choice (const "[ ]")
151 (const "☐") ; Unicode BALLOT BOX
152 string))
154 (defface eww-form-submit
155 '((((type x w32 ns) (class color)) ; Like default mode line
156 :box (:line-width 2 :style released-button)
157 :background "#808080" :foreground "black"))
158 "Face for eww buffer buttons."
159 :version "24.4"
160 :group 'eww)
162 (defface eww-form-file
163 '((((type x w32 ns) (class color)) ; Like default mode line
164 :box (:line-width 2 :style released-button)
165 :background "#808080" :foreground "black"))
166 "Face for eww buffer buttons."
167 :version "25.1"
168 :group 'eww)
170 (defface eww-form-checkbox
171 '((((type x w32 ns) (class color)) ; Like default mode line
172 :box (:line-width 2 :style released-button)
173 :background "lightgrey" :foreground "black"))
174 "Face for eww buffer buttons."
175 :version "24.4"
176 :group 'eww)
178 (defface eww-form-select
179 '((((type x w32 ns) (class color)) ; Like default mode line
180 :box (:line-width 2 :style released-button)
181 :background "lightgrey" :foreground "black"))
182 "Face for eww buffer buttons."
183 :version "24.4"
184 :group 'eww)
186 (defface eww-form-text
187 '((t (:background "#505050"
188 :foreground "white"
189 :box (:line-width 1))))
190 "Face for eww text inputs."
191 :version "24.4"
192 :group 'eww)
194 (defface eww-form-textarea
195 '((t (:background "#C0C0C0"
196 :foreground "black"
197 :box (:line-width 1))))
198 "Face for eww textarea inputs."
199 :version "24.4"
200 :group 'eww)
202 (defface eww-invalid-certificate
203 '((default :weight bold)
204 (((class color)) :foreground "red"))
205 "Face for web pages with invalid certificates."
206 :version "25.1"
207 :group 'eww)
209 (defface eww-valid-certificate
210 '((default :weight bold)
211 (((class color)) :foreground "ForestGreen"))
212 "Face for web pages with valid certificates."
213 :version "25.1"
214 :group 'eww)
216 (defvar eww-data nil)
217 (defvar eww-history nil)
218 (defvar eww-history-position 0)
220 (defvar eww-local-regex "localhost"
221 "When this regex is found in the URL, it's not a keyword but an address.")
223 (defvar eww-link-keymap
224 (let ((map (copy-keymap shr-map)))
225 (define-key map "\r" 'eww-follow-link)
226 map))
228 (defun eww-suggested-uris nil
229 "Return the list of URIs to suggest at the `eww' prompt.
230 This list can be customized via `eww-suggest-uris'."
231 (let ((obseen (make-vector 42 0))
232 (uris nil))
233 (dolist (fun eww-suggest-uris)
234 (let ((ret (funcall fun)))
235 (dolist (uri (if (stringp ret) (list ret) ret))
236 (when (and uri (not (intern-soft uri obseen)))
237 (intern uri obseen)
238 (push uri uris)))))
239 (nreverse uris)))
241 ;;;###autoload
242 (defun eww (url)
243 "Fetch URL and render the page.
244 If the input doesn't look like an URL or a domain name, the
245 word(s) will be searched for via `eww-search-prefix'."
246 (interactive
247 (let* ((uris (eww-suggested-uris))
248 (prompt (concat "Enter URL or keywords"
249 (if uris (format " (default %s)" (car uris)) "")
250 ": ")))
251 (list (read-string prompt nil nil uris))))
252 (setq url (string-trim url))
253 (cond ((string-match-p "\\`file:/" url))
254 ;; Don't mangle file: URLs at all.
255 ((string-match-p "\\`ftp://" url)
256 (user-error "FTP is not supported."))
258 (if (and (= (length (split-string url)) 1)
259 (or (and (not (string-match-p "\\`[\"\'].*[\"\']\\'" url))
260 (> (length (split-string url "[.:]")) 1))
261 (string-match eww-local-regex url)))
262 (progn
263 (unless (string-match-p "\\`[a-zA-Z][-a-zA-Z0-9+.]*://" url)
264 (setq url (concat "http://" url)))
265 ;; some site don't redirect final /
266 (when (string= (url-filename (url-generic-parse-url url)) "")
267 (setq url (concat url "/"))))
268 (setq url (concat eww-search-prefix
269 (replace-regexp-in-string " " "+" url))))))
270 (if (eq major-mode 'eww-mode)
271 (when (or (plist-get eww-data :url)
272 (plist-get eww-data :dom))
273 (eww-save-history))
274 (eww-setup-buffer)
275 (plist-put eww-data :url url)
276 (eww-update-header-line-format)
277 (let ((inhibit-read-only t))
278 (insert (format "Loading %s..." url))
279 (goto-char (point-min))))
280 (url-retrieve url 'eww-render
281 (list url nil (current-buffer))))
283 ;;;###autoload (defalias 'browse-web 'eww)
285 ;;;###autoload
286 (defun eww-open-file (file)
287 "Render a file using EWW."
288 (interactive "fFile: ")
289 (eww (concat "file://"
290 (and (memq system-type '(windows-nt ms-dos))
291 "/")
292 (expand-file-name file))))
294 ;;;###autoload
295 (defun eww-search-words (&optional beg end)
296 "Search the web for the text between the point and marker.
297 See the `eww-search-prefix' variable for the search engine used."
298 (interactive "r")
299 (eww (buffer-substring beg end)))
301 (defun eww-render (status url &optional point buffer encode)
302 (let ((redirect (plist-get status :redirect)))
303 (when redirect
304 (setq url redirect)))
305 (let* ((headers (eww-parse-headers))
306 (content-type
307 (mail-header-parse-content-type
308 (or (cdr (assoc "content-type" headers))
309 "text/plain")))
310 (charset (intern
311 (downcase
312 (or (cdr (assq 'charset (cdr content-type)))
313 (eww-detect-charset (equal (car content-type)
314 "text/html"))
315 "utf-8"))))
316 (data-buffer (current-buffer)))
317 ;; Save the https peer status.
318 (with-current-buffer buffer
319 (plist-put eww-data :peer (plist-get status :peer)))
320 (unwind-protect
321 (progn
322 (cond
323 ((and eww-use-external-browser-for-content-type
324 (string-match-p eww-use-external-browser-for-content-type
325 (car content-type)))
326 (eww-browse-with-external-browser url))
327 ((equal (car content-type) "text/html")
328 (eww-display-html charset url nil point buffer encode))
329 ((equal (car content-type) "application/pdf")
330 (eww-display-pdf))
331 ((string-match-p "\\`image/" (car content-type))
332 (eww-display-image buffer))
334 (eww-display-raw buffer encode)))
335 (with-current-buffer buffer
336 (plist-put eww-data :url url)
337 (eww-update-header-line-format)
338 (setq eww-history-position 0)
339 (run-hooks 'eww-after-render-hook)))
340 (kill-buffer data-buffer))))
342 (defun eww-parse-headers ()
343 (let ((headers nil))
344 (goto-char (point-min))
345 (while (and (not (eobp))
346 (not (eolp)))
347 (when (looking-at "\\([^:]+\\): *\\(.*\\)")
348 (push (cons (downcase (match-string 1))
349 (match-string 2))
350 headers))
351 (forward-line 1))
352 (unless (eobp)
353 (forward-line 1))
354 headers))
356 (defun eww-detect-charset (html-p)
357 (let ((case-fold-search t)
358 (pt (point)))
359 (or (and html-p
360 (re-search-forward
361 "<meta[\t\n\r ]+[^>]*charset=\"?\\([^\t\n\r \"/>]+\\)[\\\"'.*]" nil t)
362 (goto-char pt)
363 (match-string 1))
364 (and (looking-at
365 "[\t\n\r ]*<\\?xml[\t\n\r ]+[^>]*encoding=\"\\([^\"]+\\)")
366 (match-string 1)))))
368 (declare-function libxml-parse-html-region "xml.c"
369 (start end &optional base-url))
371 (defun eww-display-html (charset url &optional document point buffer encode)
372 (unless (fboundp 'libxml-parse-html-region)
373 (error "This function requires Emacs to be compiled with libxml2"))
374 (unless (buffer-live-p buffer)
375 (error "Buffer %s doesn't exist" buffer))
376 ;; There should be a better way to abort loading images
377 ;; asynchronously.
378 (setq url-queue nil)
379 (let ((document
380 (or document
381 (list
382 'base (list (cons 'href url))
383 (progn
384 (when (or (and encode
385 (not (eq charset encode)))
386 (not (eq charset 'utf-8)))
387 (condition-case nil
388 (decode-coding-region (point) (point-max)
389 (or encode charset))
390 (coding-system-error nil)))
391 (libxml-parse-html-region (point) (point-max))))))
392 (source (and (null document)
393 (buffer-substring (point) (point-max)))))
394 (with-current-buffer buffer
395 (plist-put eww-data :source source)
396 (plist-put eww-data :dom document)
397 (let ((inhibit-read-only t)
398 (inhibit-modification-hooks t)
399 (shr-target-id (url-target (url-generic-parse-url url)))
400 (shr-external-rendering-functions
401 '((title . eww-tag-title)
402 (form . eww-tag-form)
403 (input . eww-tag-input)
404 (textarea . eww-tag-textarea)
405 (body . eww-tag-body)
406 (select . eww-tag-select)
407 (link . eww-tag-link)
408 (a . eww-tag-a))))
409 (erase-buffer)
410 (shr-insert-document document)
411 (cond
412 (point
413 (goto-char point))
414 (shr-target-id
415 (goto-char (point-min))
416 (let ((point (next-single-property-change
417 (point-min) 'shr-target-id)))
418 (when point
419 (goto-char point))))
421 (goto-char (point-min))
422 ;; Don't leave point inside forms, because the normal eww
423 ;; commands aren't available there.
424 (while (and (not (eobp))
425 (get-text-property (point) 'eww-form))
426 (forward-line 1)))))
427 (eww-size-text-inputs))))
429 (defun eww-handle-link (dom)
430 (let* ((rel (dom-attr dom 'rel))
431 (href (dom-attr dom 'href))
432 (where (assoc
433 ;; The text associated with :rel is case-insensitive.
434 (if rel (downcase rel))
435 '(("next" . :next)
436 ;; Texinfo uses "previous", but HTML specifies
437 ;; "prev", so recognize both.
438 ("previous" . :previous)
439 ("prev" . :previous)
440 ;; HTML specifies "start" but also "contents",
441 ;; and Gtk seems to use "home". Recognize
442 ;; them all; but store them in different
443 ;; variables so that we can readily choose the
444 ;; "best" one.
445 ("start" . :start)
446 ("home" . :home)
447 ("contents" . :contents)
448 ("up" . :up)))))
449 (and href
450 where
451 (plist-put eww-data (cdr where) href))))
453 (defun eww-tag-link (dom)
454 (eww-handle-link dom)
455 (shr-generic dom))
457 (defun eww-tag-a (dom)
458 (eww-handle-link dom)
459 (let ((start (point)))
460 (shr-tag-a dom)
461 (put-text-property start (point) 'keymap eww-link-keymap)))
463 (defun eww-update-header-line-format ()
464 (setq header-line-format
465 (and eww-header-line-format
466 (let ((title (plist-get eww-data :title))
467 (peer (plist-get eww-data :peer)))
468 (when (zerop (length title))
469 (setq title "[untitled]"))
470 ;; This connection has is https.
471 (when peer
472 (setq title
473 (propertize title 'face
474 (if (plist-get peer :warnings)
475 'eww-invalid-certificate
476 'eww-valid-certificate))))
477 (replace-regexp-in-string
478 "%" "%%"
479 (format-spec
480 eww-header-line-format
481 `((?u . ,(or (plist-get eww-data :url) ""))
482 (?t . ,title))))))))
484 (defun eww-tag-title (dom)
485 (plist-put eww-data :title
486 (replace-regexp-in-string
487 "^ \\| $" ""
488 (replace-regexp-in-string "[ \t\r\n]+" " " (dom-text dom))))
489 (eww-update-header-line-format))
491 (defun eww-tag-body (dom)
492 (let* ((start (point))
493 (fgcolor (or (dom-attr dom 'fgcolor) (dom-attr dom 'text)))
494 (bgcolor (dom-attr dom 'bgcolor))
495 (shr-stylesheet (list (cons 'color fgcolor)
496 (cons 'background-color bgcolor))))
497 (shr-generic dom)
498 (shr-colorize-region start (point) fgcolor bgcolor)))
500 (defun eww-display-raw (buffer &optional encode)
501 (let ((data (buffer-substring (point) (point-max))))
502 (unless (buffer-live-p buffer)
503 (error "Buffer %s doesn't exist" buffer))
504 (with-current-buffer buffer
505 (let ((inhibit-read-only t))
506 (erase-buffer)
507 (insert data)
508 (unless (eq encode 'utf-8)
509 (encode-coding-region (point-min) (1+ (length data)) 'utf-8)
510 (condition-case nil
511 (decode-coding-region (point-min) (1+ (length data)) encode)
512 (coding-system-error nil))))
513 (goto-char (point-min)))))
515 (defun eww-display-image (buffer)
516 (let ((data (shr-parse-image-data)))
517 (unless (buffer-live-p buffer)
518 (error "Buffer %s doesn't exist" buffer))
519 (with-current-buffer buffer
520 (let ((inhibit-read-only t))
521 (erase-buffer)
522 (shr-put-image data nil))
523 (goto-char (point-min)))))
525 (declare-function mailcap-view-mime "mailcap" (type))
526 (defun eww-display-pdf ()
527 (let ((data (buffer-substring (point) (point-max))))
528 (switch-to-buffer (get-buffer-create "*eww pdf*"))
529 (let ((coding-system-for-write 'raw-text)
530 (inhibit-read-only t))
531 (erase-buffer)
532 (insert data)
533 (mailcap-view-mime "application/pdf")))
534 (goto-char (point-min)))
536 (defun eww-setup-buffer ()
537 (switch-to-buffer (get-buffer-create "*eww*"))
538 (let ((inhibit-read-only t))
539 (remove-overlays)
540 (erase-buffer))
541 (unless (eq major-mode 'eww-mode)
542 (eww-mode)))
544 (defun eww-current-url nil
545 "Return URI of the Web page the current EWW buffer is visiting."
546 (plist-get eww-data :url))
548 (defun eww-links-at-point (&optional pt)
549 "Return list of URIs, if any, linked at point."
550 (remq nil
551 (list (get-text-property (point) 'shr-url)
552 (get-text-property (point) 'image-url))))
554 (defun eww-view-source ()
555 "View the HTML source code of the current page."
556 (interactive)
557 (let ((buf (get-buffer-create "*eww-source*"))
558 (source (plist-get eww-data :source)))
559 (with-current-buffer buf
560 (let ((inhibit-read-only t))
561 (delete-region (point-min) (point-max))
562 (insert (or source "no source"))
563 (goto-char (point-min))
564 (when (fboundp 'html-mode)
565 (html-mode))))
566 (view-buffer buf)))
568 (defun eww-readable ()
569 "View the main \"readable\" parts of the current web page.
570 This command uses heuristics to find the parts of the web page that
571 contains the main textual portion, leaving out navigation menus and
572 the like."
573 (interactive)
574 (let* ((old-data eww-data)
575 (dom (with-temp-buffer
576 (insert (plist-get old-data :source))
577 (condition-case nil
578 (decode-coding-region (point-min) (point-max) 'utf-8)
579 (coding-system-error nil))
580 (libxml-parse-html-region (point-min) (point-max)))))
581 (eww-score-readability dom)
582 (eww-save-history)
583 (eww-display-html nil nil
584 (eww-highest-readability dom)
585 nil (current-buffer))
586 (dolist (elem '(:source :url :title :next :previous :up))
587 (plist-put eww-data elem (plist-get old-data elem)))
588 (eww-update-header-line-format)))
590 (defun eww-score-readability (node)
591 (let ((score -1))
592 (cond
593 ((memq (dom-tag node) '(script head comment))
594 (setq score -2))
595 ((eq (dom-tag node) 'meta)
596 (setq score -1))
597 ((eq (dom-tag node) 'img)
598 (setq score 2))
599 ((eq (dom-tag node) 'a)
600 (setq score (- (length (split-string (dom-text node))))))
602 (dolist (elem (dom-children node))
603 (if (stringp elem)
604 (setq score (+ score (length (split-string elem))))
605 (setq score (+ score
606 (or (cdr (assoc :eww-readability-score (cdr elem)))
607 (eww-score-readability elem))))))))
608 ;; Cache the score of the node to avoid recomputing all the time.
609 (dom-set-attribute node :eww-readability-score score)
610 score))
612 (defun eww-highest-readability (node)
613 (let ((result node)
614 highest)
615 (dolist (elem (dom-non-text-children node))
616 (when (> (or (dom-attr
617 (setq highest (eww-highest-readability elem))
618 :eww-readability-score)
619 most-negative-fixnum)
620 (or (dom-attr result :eww-readability-score)
621 most-negative-fixnum))
622 (setq result highest)))
623 result))
625 (defvar eww-mode-map
626 (let ((map (make-sparse-keymap)))
627 (suppress-keymap map)
628 (define-key map "q" 'quit-window)
629 (define-key map "g" 'eww-reload)
630 (define-key map "G" 'eww)
631 (define-key map [?\t] 'shr-next-link)
632 (define-key map [?\M-\t] 'shr-previous-link)
633 (define-key map [backtab] 'shr-previous-link)
634 (define-key map [delete] 'scroll-down-command)
635 (define-key map [?\S-\ ] 'scroll-down-command)
636 (define-key map "\177" 'scroll-down-command)
637 (define-key map " " 'scroll-up-command)
638 (define-key map "l" 'eww-back-url)
639 (define-key map "r" 'eww-forward-url)
640 (define-key map "n" 'eww-next-url)
641 (define-key map "p" 'eww-previous-url)
642 (define-key map "u" 'eww-up-url)
643 (define-key map "t" 'eww-top-url)
644 (define-key map "&" 'eww-browse-with-external-browser)
645 (define-key map "d" 'eww-download)
646 (define-key map "w" 'eww-copy-page-url)
647 (define-key map "C" 'url-cookie-list)
648 (define-key map "v" 'eww-view-source)
649 (define-key map "R" 'eww-readable)
650 (define-key map "H" 'eww-list-histories)
651 (define-key map "E" 'eww-set-character-encoding)
652 (define-key map "S" 'eww-list-buffers)
654 (define-key map "b" 'eww-add-bookmark)
655 (define-key map "B" 'eww-list-bookmarks)
656 (define-key map [(meta n)] 'eww-next-bookmark)
657 (define-key map [(meta p)] 'eww-previous-bookmark)
659 (easy-menu-define nil map ""
660 '("Eww"
661 ["Exit" quit-window t]
662 ["Close browser" quit-window t]
663 ["Reload" eww-reload t]
664 ["Back to previous page" eww-back-url
665 :active (not (zerop (length eww-history)))]
666 ["Forward to next page" eww-forward-url
667 :active (not (zerop eww-history-position))]
668 ["Browse with external browser" eww-browse-with-external-browser t]
669 ["Download" eww-download t]
670 ["View page source" eww-view-source]
671 ["Copy page URL" eww-copy-page-url t]
672 ["List histories" eww-list-histories t]
673 ["List buffers" eww-list-buffers t]
674 ["Add bookmark" eww-add-bookmark t]
675 ["List bookmarks" eww-list-bookmarks t]
676 ["List cookies" url-cookie-list t]
677 ["Character Encoding" eww-set-character-encoding]))
678 map))
680 (defvar eww-tool-bar-map
681 (let ((map (make-sparse-keymap)))
682 (dolist (tool-bar-item
683 '((quit-window . "close")
684 (eww-reload . "refresh")
685 (eww-back-url . "left-arrow")
686 (eww-forward-url . "right-arrow")
687 (eww-view-source . "show")
688 (eww-copy-page-url . "copy")
689 (eww-add-bookmark . "bookmark_add"))) ;; ...
690 (tool-bar-local-item-from-menu
691 (car tool-bar-item) (cdr tool-bar-item) map eww-mode-map))
692 map)
693 "Tool bar for `eww-mode'.")
695 (define-derived-mode eww-mode nil "eww"
696 "Mode for browsing the web.
698 \\{eww-mode-map}"
699 (setq-local eww-data (list :title ""))
700 (setq-local browse-url-browser-function 'eww-browse-url)
701 (setq-local after-change-functions 'eww-process-text-input)
702 (setq-local eww-history nil)
703 (setq-local eww-history-position 0)
704 (when (boundp 'tool-bar-map)
705 (setq-local tool-bar-map eww-tool-bar-map))
706 ;; desktop support
707 (setq-local desktop-save-buffer 'eww-desktop-misc-data)
708 ;; multi-page isearch support
709 (setq-local multi-isearch-next-buffer-function 'eww-isearch-next-buffer)
710 (setq truncate-lines t)
711 (buffer-disable-undo)
712 (setq buffer-read-only t))
714 ;;;###autoload
715 (defun eww-browse-url (url &optional new-window)
716 (cond (new-window
717 (switch-to-buffer (generate-new-buffer "*eww*"))
718 (eww-mode)))
719 (eww url))
721 (defun eww-back-url ()
722 "Go to the previously displayed page."
723 (interactive)
724 (when (>= eww-history-position (length eww-history))
725 (user-error "No previous page"))
726 (eww-save-history)
727 (setq eww-history-position (+ eww-history-position 2))
728 (eww-restore-history (elt eww-history (1- eww-history-position))))
730 (defun eww-forward-url ()
731 "Go to the next displayed page."
732 (interactive)
733 (when (zerop eww-history-position)
734 (user-error "No next page"))
735 (eww-save-history)
736 (eww-restore-history (elt eww-history (1- eww-history-position))))
738 (defun eww-restore-history (elem)
739 (let ((inhibit-read-only t)
740 (inhibit-modification-hooks t)
741 (text (plist-get elem :text)))
742 (setq eww-data elem)
743 (if (null text)
744 (eww-reload) ; FIXME: restore :point?
745 (erase-buffer)
746 (insert text)
747 (goto-char (plist-get elem :point))
748 (eww-update-header-line-format))))
750 (defun eww-next-url ()
751 "Go to the page marked `next'.
752 A page is marked `next' if rel=\"next\" appears in a <link>
753 or <a> tag."
754 (interactive)
755 (if (plist-get eww-data :next)
756 (eww-browse-url (shr-expand-url (plist-get eww-data :next)
757 (plist-get eww-data :url)))
758 (user-error "No `next' on this page")))
760 (defun eww-previous-url ()
761 "Go to the page marked `previous'.
762 A page is marked `previous' if rel=\"previous\" appears in a <link>
763 or <a> tag."
764 (interactive)
765 (if (plist-get eww-data :previous)
766 (eww-browse-url (shr-expand-url (plist-get eww-data :previous)
767 (plist-get eww-data :url)))
768 (user-error "No `previous' on this page")))
770 (defun eww-up-url ()
771 "Go to the page marked `up'.
772 A page is marked `up' if rel=\"up\" appears in a <link>
773 or <a> tag."
774 (interactive)
775 (if (plist-get eww-data :up)
776 (eww-browse-url (shr-expand-url (plist-get eww-data :up)
777 (plist-get eww-data :url)))
778 (user-error "No `up' on this page")))
780 (defun eww-top-url ()
781 "Go to the page marked `top'.
782 A page is marked `top' if rel=\"start\", rel=\"home\", or rel=\"contents\"
783 appears in a <link> or <a> tag."
784 (interactive)
785 (let ((best-url (or (plist-get eww-data :start)
786 (plist-get eww-data :contents)
787 (plist-get eww-data :home))))
788 (if best-url
789 (eww-browse-url (shr-expand-url best-url (plist-get eww-data :url)))
790 (user-error "No `top' for this page"))))
792 (defun eww-reload (&optional local encode)
793 "Reload the current page.
794 If LOCAL (the command prefix), don't reload the page from the
795 network, but just re-display the HTML already fetched."
796 (interactive "P")
797 (let ((url (plist-get eww-data :url)))
798 (if local
799 (if (null (plist-get eww-data :dom))
800 (error "No current HTML data")
801 (eww-display-html 'utf-8 url (plist-get eww-data :dom)
802 (point) (current-buffer)))
803 (url-retrieve url 'eww-render
804 (list url (point) (current-buffer) encode)))))
806 ;; Form support.
808 (defvar eww-form nil)
810 (defvar eww-submit-map
811 (let ((map (make-sparse-keymap)))
812 (define-key map "\r" 'eww-submit)
813 (define-key map [(control c) (control c)] 'eww-submit)
814 map))
816 (defvar eww-submit-file
817 (let ((map (make-sparse-keymap)))
818 (define-key map "\r" 'eww-select-file)
819 (define-key map [(control c) (control c)] 'eww-submit)
820 map))
822 (defvar eww-checkbox-map
823 (let ((map (make-sparse-keymap)))
824 (define-key map " " 'eww-toggle-checkbox)
825 (define-key map "\r" 'eww-toggle-checkbox)
826 (define-key map [(control c) (control c)] 'eww-submit)
827 map))
829 (defvar eww-text-map
830 (let ((map (make-keymap)))
831 (set-keymap-parent map text-mode-map)
832 (define-key map "\r" 'eww-submit)
833 (define-key map [(control a)] 'eww-beginning-of-text)
834 (define-key map [(control c) (control c)] 'eww-submit)
835 (define-key map [(control e)] 'eww-end-of-text)
836 (define-key map [?\t] 'shr-next-link)
837 (define-key map [?\M-\t] 'shr-previous-link)
838 map))
840 (defvar eww-textarea-map
841 (let ((map (make-keymap)))
842 (set-keymap-parent map text-mode-map)
843 (define-key map "\r" 'forward-line)
844 (define-key map [(control c) (control c)] 'eww-submit)
845 (define-key map [?\t] 'shr-next-link)
846 (define-key map [?\M-\t] 'shr-previous-link)
847 map))
849 (defvar eww-select-map
850 (let ((map (make-sparse-keymap)))
851 (define-key map "\r" 'eww-change-select)
852 (define-key map [(control c) (control c)] 'eww-submit)
853 map))
855 (defun eww-beginning-of-text ()
856 "Move to the start of the input field."
857 (interactive)
858 (goto-char (eww-beginning-of-field)))
860 (defun eww-end-of-text ()
861 "Move to the end of the text in the input field."
862 (interactive)
863 (goto-char (eww-end-of-field))
864 (let ((start (eww-beginning-of-field)))
865 (while (and (equal (following-char) ? )
866 (> (point) start))
867 (forward-char -1))
868 (when (> (point) start)
869 (forward-char 1))))
871 (defun eww-beginning-of-field ()
872 (cond
873 ((bobp)
874 (point))
875 ((not (eq (get-text-property (point) 'eww-form)
876 (get-text-property (1- (point)) 'eww-form)))
877 (point))
879 (previous-single-property-change
880 (point) 'eww-form nil (point-min)))))
882 (defun eww-end-of-field ()
883 (1- (next-single-property-change
884 (point) 'eww-form nil (point-max))))
886 (defun eww-tag-form (dom)
887 (let ((eww-form (list (cons :method (dom-attr dom 'method))
888 (cons :action (dom-attr dom 'action))))
889 (start (point)))
890 (shr-ensure-paragraph)
891 (shr-generic dom)
892 (unless (bolp)
893 (insert "\n"))
894 (insert "\n")
895 (when (> (point) start)
896 (put-text-property start (1+ start)
897 'eww-form eww-form))))
899 (defun eww-form-submit (dom)
900 (let ((start (point))
901 (value (dom-attr dom 'value)))
902 (setq value
903 (if (zerop (length value))
904 "Submit"
905 value))
906 (insert value)
907 (add-face-text-property start (point) 'eww-form-submit)
908 (put-text-property start (point) 'eww-form
909 (list :eww-form eww-form
910 :value value
911 :type "submit"
912 :name (dom-attr dom 'name)))
913 (put-text-property start (point) 'keymap eww-submit-map)
914 (insert " ")))
916 (defun eww-form-checkbox (dom)
917 (let ((start (point)))
918 (if (dom-attr dom 'checked)
919 (insert eww-form-checkbox-selected-symbol)
920 (insert eww-form-checkbox-symbol))
921 (add-face-text-property start (point) 'eww-form-checkbox)
922 (put-text-property start (point) 'eww-form
923 (list :eww-form eww-form
924 :value (dom-attr dom 'value)
925 :type (downcase (dom-attr dom 'type))
926 :checked (dom-attr dom 'checked)
927 :name (dom-attr dom 'name)))
928 (put-text-property start (point) 'keymap eww-checkbox-map)
929 (insert " ")))
931 (defun eww-form-file (dom)
932 (let ((start (point))
933 (value (dom-attr dom 'value)))
934 (setq value
935 (if (zerop (length value))
936 " No file selected"
937 value))
938 (insert "Browse")
939 (add-face-text-property start (point) 'eww-form-file)
940 (insert value)
941 (put-text-property start (point) 'eww-form
942 (list :eww-form eww-form
943 :value (dom-attr dom 'value)
944 :type (downcase (dom-attr dom 'type))
945 :name (dom-attr dom 'name)))
946 (put-text-property start (point) 'keymap eww-submit-file)
947 (insert " ")))
949 (defun eww-select-file ()
950 "Change the value of the upload file menu under point."
951 (interactive)
952 (let* ((input (get-text-property (point) 'eww-form)))
953 (let ((filename
954 (let ((insert-default-directory t))
955 (read-file-name "filename: "))))
956 (eww-update-field filename (length "Browse"))
957 (plist-put input :filename filename))))
959 (defun eww-form-text (dom)
960 (let ((start (point))
961 (type (downcase (or (dom-attr dom 'type) "text")))
962 (value (or (dom-attr dom 'value) ""))
963 (width (string-to-number (or (dom-attr dom 'size) "40")))
964 (readonly-property (if (or (dom-attr dom 'disabled)
965 (dom-attr dom 'readonly))
966 'read-only
967 'inhibit-read-only)))
968 (insert value)
969 (when (< (length value) width)
970 (insert (make-string (- width (length value)) ? )))
971 (put-text-property start (point) 'face 'eww-form-text)
972 (put-text-property start (point) 'inhibit-read-only t)
973 (put-text-property start (point) 'local-map eww-text-map)
974 (put-text-property start (point) readonly-property t)
975 (put-text-property start (point) 'eww-form
976 (list :eww-form eww-form
977 :value value
978 :type type
979 :name (dom-attr dom 'name)))
980 (insert " ")))
982 (defconst eww-text-input-types '("text" "password" "textarea"
983 "color" "date" "datetime" "datetime-local"
984 "email" "month" "number" "search" "tel"
985 "time" "url" "week")
986 "List of input types which represent a text input.
987 See URL `https://developer.mozilla.org/en-US/docs/Web/HTML/Element/Input'.")
989 (defun eww-process-text-input (beg end replace-length)
990 (when-let (pos (and (< (1+ end) (point-max))
991 (> (1- end) (point-min))
992 (cond
993 ((get-text-property (1+ end) 'eww-form)
994 (1+ end))
995 ((get-text-property (1- end) 'eww-form)
996 (1- end)))))
997 (let* ((form (get-text-property pos 'eww-form))
998 (properties (text-properties-at pos))
999 (inhibit-read-only t)
1000 (length (- end beg replace-length))
1001 (type (plist-get form :type)))
1002 (when (and form
1003 (member type eww-text-input-types))
1004 (cond
1005 ((> length 0)
1006 ;; Delete some space at the end.
1007 (save-excursion
1008 (goto-char
1009 (if (equal type "textarea")
1010 (1- (line-end-position))
1011 (eww-end-of-field)))
1012 (while (and (> length 0)
1013 (eql (following-char) ? ))
1014 (delete-region (1- (point)) (point))
1015 (cl-decf length))))
1016 ((< length 0)
1017 ;; Add padding.
1018 (save-excursion
1019 (goto-char (1- end))
1020 (goto-char
1021 (if (equal type "textarea")
1022 (1- (line-end-position))
1023 (1+ (eww-end-of-field))))
1024 (let ((start (point)))
1025 (insert (make-string (abs length) ? ))
1026 (set-text-properties start (point) properties))
1027 (goto-char (1- end)))))
1028 (set-text-properties (plist-get form :start) (plist-get form :end)
1029 properties)
1030 (let ((value (buffer-substring-no-properties
1031 (eww-beginning-of-field)
1032 (eww-end-of-field))))
1033 (when (string-match " +\\'" value)
1034 (setq value (substring value 0 (match-beginning 0))))
1035 (plist-put form :value value)
1036 (when (equal type "password")
1037 ;; Display passwords as asterisks.
1038 (let ((start (eww-beginning-of-field)))
1039 (put-text-property start (+ start (length value))
1040 'display (make-string (length value) ?*)))))))))
1042 (defun eww-tag-textarea (dom)
1043 (let ((start (point))
1044 (value (or (dom-attr dom 'value) ""))
1045 (lines (string-to-number (or (dom-attr dom 'rows) "10")))
1046 (width (string-to-number (or (dom-attr dom 'cols) "10")))
1047 end)
1048 (shr-ensure-newline)
1049 (insert value)
1050 (shr-ensure-newline)
1051 (when (< (count-lines start (point)) lines)
1052 (dotimes (i (- lines (count-lines start (point))))
1053 (insert "\n")))
1054 (setq end (point-marker))
1055 (goto-char start)
1056 (while (< (point) end)
1057 (end-of-line)
1058 (let ((pad (- width (- (point) (line-beginning-position)))))
1059 (when (> pad 0)
1060 (insert (make-string pad ? ))))
1061 (add-face-text-property (line-beginning-position)
1062 (point) 'eww-form-textarea)
1063 (put-text-property (line-beginning-position) (point) 'inhibit-read-only t)
1064 (put-text-property (line-beginning-position) (point)
1065 'local-map eww-textarea-map)
1066 (forward-line 1))
1067 (put-text-property start (point) 'eww-form
1068 (list :eww-form eww-form
1069 :value value
1070 :type "textarea"
1071 :name (dom-attr dom 'name)))))
1073 (defun eww-tag-input (dom)
1074 (let ((type (downcase (or (dom-attr dom 'type) "text")))
1075 (start (point)))
1076 (cond
1077 ((or (equal type "checkbox")
1078 (equal type "radio"))
1079 (eww-form-checkbox dom))
1080 ((equal type "file")
1081 (eww-form-file dom))
1082 ((equal type "submit")
1083 (eww-form-submit dom))
1084 ((equal type "hidden")
1085 (let ((form eww-form)
1086 (name (dom-attr dom 'name)))
1087 ;; Don't add <input type=hidden> elements repeatedly.
1088 (while (and form
1089 (or (not (consp (car form)))
1090 (not (eq (caar form) 'hidden))
1091 (not (equal (plist-get (cdr (car form)) :name)
1092 name))))
1093 (setq form (cdr form)))
1094 (unless form
1095 (nconc eww-form (list
1096 (list 'hidden
1097 :name name
1098 :value (dom-attr dom 'value)))))))
1100 (eww-form-text dom)))
1101 (unless (= start (point))
1102 (put-text-property start (1+ start) 'help-echo "Input field"))))
1104 (defun eww-tag-select (dom)
1105 (shr-ensure-paragraph)
1106 (let ((menu (list :name (dom-attr dom 'name)
1107 :eww-form eww-form))
1108 (options nil)
1109 (start (point))
1110 (max 0)
1111 opelem)
1112 (if (eq (dom-tag dom) 'optgroup)
1113 (dolist (groupelem (dom-children dom))
1114 (unless (dom-attr groupelem 'disabled)
1115 (setq opelem (append opelem (list groupelem)))))
1116 (setq opelem (list dom)))
1117 (dolist (elem opelem)
1118 (when (eq (dom-tag elem) 'option)
1119 (when (dom-attr elem 'selected)
1120 (nconc menu (list :value (dom-attr elem 'value))))
1121 (let ((display (dom-text elem)))
1122 (setq max (max max (length display)))
1123 (push (list 'item
1124 :value (dom-attr elem 'value)
1125 :display display)
1126 options))))
1127 (when options
1128 (setq options (nreverse options))
1129 ;; If we have no selected values, default to the first value.
1130 (unless (plist-get menu :value)
1131 (nconc menu (list :value (nth 2 (car options)))))
1132 (nconc menu options)
1133 (let ((selected (eww-select-display menu)))
1134 (insert selected
1135 (make-string (- max (length selected)) ? )))
1136 (put-text-property start (point) 'eww-form menu)
1137 (add-face-text-property start (point) 'eww-form-select)
1138 (put-text-property start (point) 'keymap eww-select-map)
1139 (unless (= start (point))
1140 (put-text-property start (1+ start) 'help-echo "select field"))
1141 (shr-ensure-paragraph))))
1143 (defun eww-select-display (select)
1144 (let ((value (plist-get select :value))
1145 display)
1146 (dolist (elem select)
1147 (when (and (consp elem)
1148 (eq (car elem) 'item)
1149 (equal value (plist-get (cdr elem) :value)))
1150 (setq display (plist-get (cdr elem) :display))))
1151 display))
1153 (defun eww-change-select ()
1154 "Change the value of the select drop-down menu under point."
1155 (interactive)
1156 (let* ((input (get-text-property (point) 'eww-form))
1157 (completion-ignore-case t)
1158 (options
1159 (delq nil
1160 (mapcar (lambda (elem)
1161 (and (consp elem)
1162 (eq (car elem) 'item)
1163 (cons (plist-get (cdr elem) :display)
1164 (plist-get (cdr elem) :value))))
1165 input)))
1166 (display
1167 (completing-read "Change value: " options nil 'require-match))
1168 (inhibit-read-only t))
1169 (plist-put input :value (cdr (assoc-string display options t)))
1170 (goto-char
1171 (eww-update-field display))))
1173 (defun eww-update-field (string &optional offset)
1174 (if (not offset) (setq offset 0))
1175 (let ((properties (text-properties-at (point)))
1176 (start (+ (eww-beginning-of-field) offset))
1177 (current-end (1+ (eww-end-of-field)))
1178 (new-end (1+ (+ (eww-beginning-of-field) (length string)))))
1179 (delete-region start current-end)
1180 (forward-char offset)
1181 (insert string
1182 (make-string (- (- (+ new-end offset) start) (length string)) ? ))
1183 (if (= 0 offset) (set-text-properties start new-end properties))
1184 start))
1186 (defun eww-toggle-checkbox ()
1187 "Toggle the value of the checkbox under point."
1188 (interactive)
1189 (let* ((input (get-text-property (point) 'eww-form))
1190 (type (plist-get input :type)))
1191 (if (equal type "checkbox")
1192 (goto-char
1194 (if (plist-get input :checked)
1195 (progn
1196 (plist-put input :checked nil)
1197 (eww-update-field eww-form-checkbox-symbol))
1198 (plist-put input :checked t)
1199 (eww-update-field eww-form-checkbox-selected-symbol))))
1200 ;; Radio button. Switch all other buttons off.
1201 (let ((name (plist-get input :name)))
1202 (save-excursion
1203 (dolist (elem (eww-inputs (plist-get input :eww-form)))
1204 (when (equal (plist-get (cdr elem) :name) name)
1205 (goto-char (car elem))
1206 (if (not (eq (cdr elem) input))
1207 (progn
1208 (plist-put input :checked nil)
1209 (eww-update-field eww-form-checkbox-symbol))
1210 (plist-put input :checked t)
1211 (eww-update-field eww-form-checkbox-selected-symbol)))))
1212 (forward-char 1)))))
1214 (defun eww-inputs (form)
1215 (let ((start (point-min))
1216 (inputs nil))
1217 (while (and start
1218 (< start (point-max)))
1219 (when (or (get-text-property start 'eww-form)
1220 (setq start (next-single-property-change start 'eww-form)))
1221 (when (eq (plist-get (get-text-property start 'eww-form) :eww-form)
1222 form)
1223 (push (cons start (get-text-property start 'eww-form))
1224 inputs))
1225 (setq start (next-single-property-change start 'eww-form))))
1226 (nreverse inputs)))
1228 (defun eww-size-text-inputs ()
1229 (let ((start (point-min)))
1230 (while (and start
1231 (< start (point-max)))
1232 (when (or (get-text-property start 'eww-form)
1233 (setq start (next-single-property-change start 'eww-form)))
1234 (let ((props (get-text-property start 'eww-form)))
1235 (plist-put props :start start)
1236 (setq start (next-single-property-change
1237 start 'eww-form nil (point-max)))
1238 (plist-put props :end start))))))
1240 (defun eww-input-value (input)
1241 (let ((type (plist-get input :type))
1242 (value (plist-get input :value)))
1243 (cond
1244 ((equal type "textarea")
1245 (with-temp-buffer
1246 (insert value)
1247 (goto-char (point-min))
1248 (while (re-search-forward "^ +\n\\| +$" nil t)
1249 (replace-match "" t t))
1250 (buffer-string)))
1252 (if (string-match " +\\'" value)
1253 (substring value 0 (match-beginning 0))
1254 value)))))
1256 (defun eww-submit ()
1257 "Submit the current form."
1258 (interactive)
1259 (let* ((this-input (get-text-property (point) 'eww-form))
1260 (form (plist-get this-input :eww-form))
1261 values next-submit)
1262 (dolist (elem (sort (eww-inputs form)
1263 (lambda (o1 o2)
1264 (< (car o1) (car o2)))))
1265 (let* ((input (cdr elem))
1266 (input-start (car elem))
1267 (name (plist-get input :name)))
1268 (when name
1269 (cond
1270 ((member (plist-get input :type) '("checkbox" "radio"))
1271 (when (plist-get input :checked)
1272 (push (cons name (plist-get input :value))
1273 values)))
1274 ((equal (plist-get input :type) "file")
1275 (push (cons "file"
1276 (list (cons "filedata"
1277 (with-temp-buffer
1278 (insert-file-contents
1279 (plist-get input :filename))
1280 (buffer-string)))
1281 (cons "name" (plist-get input :name))
1282 (cons "filename" (plist-get input :filename))))
1283 values))
1284 ((equal (plist-get input :type) "submit")
1285 ;; We want the values from buttons if we hit a button if
1286 ;; we hit enter on it, or if it's the first button after
1287 ;; the field we did hit return on.
1288 (when (or (eq input this-input)
1289 (and (not (eq input this-input))
1290 (null next-submit)
1291 (> input-start (point))))
1292 (setq next-submit t)
1293 (push (cons name (plist-get input :value))
1294 values)))
1296 (push (cons name (eww-input-value input))
1297 values))))))
1298 (dolist (elem form)
1299 (when (and (consp elem)
1300 (eq (car elem) 'hidden))
1301 (push (cons (plist-get (cdr elem) :name)
1302 (or (plist-get (cdr elem) :value) ""))
1303 values)))
1304 (if (and (stringp (cdr (assq :method form)))
1305 (equal (downcase (cdr (assq :method form))) "post"))
1306 (let ((mtype))
1307 (dolist (x values mtype)
1308 (if (equal (car x) "file")
1309 (progn
1310 (setq mtype "multipart/form-data"))))
1311 (cond ((equal mtype "multipart/form-data")
1312 (let ((boundary (mml-compute-boundary '())))
1313 (let ((url-request-method "POST")
1314 (url-request-extra-headers
1315 (list (cons "Content-Type"
1316 (concat "multipart/form-data; boundary="
1317 boundary))))
1318 (url-request-data
1319 (mm-url-encode-multipart-form-data values boundary)))
1320 (eww-browse-url (shr-expand-url
1321 (cdr (assq :action form))
1322 (plist-get eww-data :url))))))
1324 (let ((url-request-method "POST")
1325 (url-request-extra-headers
1326 '(("Content-Type" .
1327 "application/x-www-form-urlencoded")))
1328 (url-request-data
1329 (mm-url-encode-www-form-urlencoded values)))
1330 (eww-browse-url (shr-expand-url
1331 (cdr (assq :action form))
1332 (plist-get eww-data :url)))))))
1333 (eww-browse-url
1334 (concat
1335 (if (cdr (assq :action form))
1336 (shr-expand-url (cdr (assq :action form)) (plist-get eww-data :url))
1337 (plist-get eww-data :url))
1339 (mm-url-encode-www-form-urlencoded values))))))
1341 (defun eww-browse-with-external-browser (&optional url)
1342 "Browse the current URL with an external browser.
1343 The browser to used is specified by the `shr-external-browser' variable."
1344 (interactive)
1345 (funcall shr-external-browser (or url (plist-get eww-data :url))))
1347 (defun eww-follow-link (&optional external mouse-event)
1348 "Browse the URL under point.
1349 If EXTERNAL is single prefix, browse the URL using `shr-external-browser'.
1350 If EXTERNAL is double prefix, browse in new buffer."
1351 (interactive (list current-prefix-arg last-nonmenu-event))
1352 (mouse-set-point mouse-event)
1353 (let ((url (get-text-property (point) 'shr-url)))
1354 (cond
1355 ((not url)
1356 (message "No link under point"))
1357 ((string-match "^mailto:" url)
1358 (browse-url-mail url))
1359 ((and (consp external) (<= (car external) 4))
1360 (funcall shr-external-browser url))
1361 ;; This is a #target url in the same page as the current one.
1362 ((and (url-target (url-generic-parse-url url))
1363 (eww-same-page-p url (plist-get eww-data :url)))
1364 (let ((dom (plist-get eww-data :dom)))
1365 (eww-save-history)
1366 (eww-display-html 'utf-8 url dom nil (current-buffer))))
1368 (eww-browse-url url external)))))
1370 (defun eww-same-page-p (url1 url2)
1371 "Return non-nil if both URLs represent the same page.
1372 Differences in #targets are ignored."
1373 (let ((obj1 (url-generic-parse-url url1))
1374 (obj2 (url-generic-parse-url url2)))
1375 (setf (url-target obj1) nil)
1376 (setf (url-target obj2) nil)
1377 (equal (url-recreate-url obj1) (url-recreate-url obj2))))
1379 (defun eww-copy-page-url ()
1380 "Copy the URL of the current page into the kill ring."
1381 (interactive)
1382 (message "%s" (plist-get eww-data :url))
1383 (kill-new (plist-get eww-data :url)))
1385 (defun eww-download ()
1386 "Download URL under point to `eww-download-directory'."
1387 (interactive)
1388 (let ((url (get-text-property (point) 'shr-url)))
1389 (if (not url)
1390 (message "No URL under point")
1391 (url-retrieve url 'eww-download-callback (list url)))))
1393 (defun eww-download-callback (status url)
1394 (unless (plist-get status :error)
1395 (let* ((obj (url-generic-parse-url url))
1396 (path (car (url-path-and-query obj)))
1397 (file (eww-make-unique-file-name (file-name-nondirectory path)
1398 eww-download-directory)))
1399 (goto-char (point-min))
1400 (re-search-forward "\r?\n\r?\n")
1401 (write-region (point) (point-max) file)
1402 (message "Saved %s" file))))
1404 (defun eww-make-unique-file-name (file directory)
1405 (cond
1406 ((zerop (length file))
1407 (setq file "!"))
1408 ((string-match "\\`[.]" file)
1409 (setq file (concat "!" file))))
1410 (let ((count 1))
1411 (while (file-exists-p (expand-file-name file directory))
1412 (setq file
1413 (if (string-match "\\`\\(.*\\)\\([.][^.]+\\)" file)
1414 (format "%s(%d)%s" (match-string 1 file)
1415 count (match-string 2 file))
1416 (format "%s(%d)" file count)))
1417 (setq count (1+ count)))
1418 (expand-file-name file directory)))
1420 (defun eww-set-character-encoding (charset)
1421 "Set character encoding."
1422 (interactive "zUse character set (default utf-8): ")
1423 (if (null charset)
1424 (eww-reload nil 'utf-8)
1425 (eww-reload nil charset)))
1427 ;;; Bookmarks code
1429 (defvar eww-bookmarks nil)
1431 (defun eww-add-bookmark ()
1432 "Add the current page to the bookmarks."
1433 (interactive)
1434 (eww-read-bookmarks)
1435 (dolist (bookmark eww-bookmarks)
1436 (when (equal (plist-get eww-data :url) (plist-get bookmark :url))
1437 (user-error "Already bookmarked")))
1438 (if (y-or-n-p "bookmark this page? ")
1439 (progn
1440 (let ((title (replace-regexp-in-string "[\n\t\r]" " "
1441 (plist-get eww-data :title))))
1442 (setq title (replace-regexp-in-string "\\` +\\| +\\'" "" title))
1443 (push (list :url (plist-get eww-data :url)
1444 :title title
1445 :time (current-time-string))
1446 eww-bookmarks))
1447 (eww-write-bookmarks)
1448 (message "Bookmarked %s (%s)" (plist-get eww-data :url)
1449 (plist-get eww-data :title)))))
1451 (defun eww-write-bookmarks ()
1452 (with-temp-file (expand-file-name "eww-bookmarks" eww-bookmarks-directory)
1453 (insert ";; Auto-generated file; don't edit\n")
1454 (pp eww-bookmarks (current-buffer))))
1456 (defun eww-read-bookmarks ()
1457 (let ((file (expand-file-name "eww-bookmarks" eww-bookmarks-directory)))
1458 (setq eww-bookmarks
1459 (unless (zerop (or (nth 7 (file-attributes file)) 0))
1460 (with-temp-buffer
1461 (insert-file-contents file)
1462 (read (current-buffer)))))))
1464 ;;;###autoload
1465 (defun eww-list-bookmarks ()
1466 "Display the bookmarks."
1467 (interactive)
1468 (eww-bookmark-prepare)
1469 (pop-to-buffer "*eww bookmarks*"))
1471 (defun eww-bookmark-prepare ()
1472 (eww-read-bookmarks)
1473 (unless eww-bookmarks
1474 (user-error "No bookmarks are defined"))
1475 (set-buffer (get-buffer-create "*eww bookmarks*"))
1476 (eww-bookmark-mode)
1477 (let* ((width (/ (window-width) 2))
1478 (format (format "%%-%ds %%s" width))
1479 (inhibit-read-only t)
1480 start title)
1481 (erase-buffer)
1482 (setq header-line-format (concat " " (format format "Title" "URL")))
1483 (dolist (bookmark eww-bookmarks)
1484 (setq start (point)
1485 title (plist-get bookmark :title))
1486 (when (> (length title) width)
1487 (setq title (substring title 0 width)))
1488 (insert (format format title (plist-get bookmark :url)) "\n")
1489 (put-text-property start (1+ start) 'eww-bookmark bookmark))
1490 (goto-char (point-min))))
1492 (defvar eww-bookmark-kill-ring nil)
1494 (defun eww-bookmark-kill ()
1495 "Kill the current bookmark."
1496 (interactive)
1497 (let* ((start (line-beginning-position))
1498 (bookmark (get-text-property start 'eww-bookmark))
1499 (inhibit-read-only t))
1500 (unless bookmark
1501 (user-error "No bookmark on the current line"))
1502 (forward-line 1)
1503 (push (buffer-substring start (point)) eww-bookmark-kill-ring)
1504 (delete-region start (point))
1505 (setq eww-bookmarks (delq bookmark eww-bookmarks))
1506 (eww-write-bookmarks)))
1508 (defun eww-bookmark-yank ()
1509 "Yank a previously killed bookmark to the current line."
1510 (interactive)
1511 (unless eww-bookmark-kill-ring
1512 (user-error "No previously killed bookmark"))
1513 (beginning-of-line)
1514 (let ((inhibit-read-only t)
1515 (start (point))
1516 bookmark)
1517 (insert (pop eww-bookmark-kill-ring))
1518 (setq bookmark (get-text-property start 'eww-bookmark))
1519 (if (= start (point-min))
1520 (push bookmark eww-bookmarks)
1521 (let ((line (count-lines start (point))))
1522 (setcdr (nthcdr (1- line) eww-bookmarks)
1523 (cons bookmark (nthcdr line eww-bookmarks)))))
1524 (eww-write-bookmarks)))
1526 (defun eww-bookmark-browse ()
1527 "Browse the bookmark under point in eww."
1528 (interactive)
1529 (let ((bookmark (get-text-property (line-beginning-position) 'eww-bookmark)))
1530 (unless bookmark
1531 (user-error "No bookmark on the current line"))
1532 (quit-window)
1533 (eww-browse-url (plist-get bookmark :url))))
1535 (defun eww-next-bookmark ()
1536 "Go to the next bookmark in the list."
1537 (interactive)
1538 (let ((first nil)
1539 bookmark)
1540 (unless (get-buffer "*eww bookmarks*")
1541 (setq first t)
1542 (eww-bookmark-prepare))
1543 (with-current-buffer (get-buffer "*eww bookmarks*")
1544 (when (and (not first)
1545 (not (eobp)))
1546 (forward-line 1))
1547 (setq bookmark (get-text-property (line-beginning-position)
1548 'eww-bookmark))
1549 (unless bookmark
1550 (user-error "No next bookmark")))
1551 (eww-browse-url (plist-get bookmark :url))))
1553 (defun eww-previous-bookmark ()
1554 "Go to the previous bookmark in the list."
1555 (interactive)
1556 (let ((first nil)
1557 bookmark)
1558 (unless (get-buffer "*eww bookmarks*")
1559 (setq first t)
1560 (eww-bookmark-prepare))
1561 (with-current-buffer (get-buffer "*eww bookmarks*")
1562 (if first
1563 (goto-char (point-max))
1564 (beginning-of-line))
1565 ;; On the final line.
1566 (when (eolp)
1567 (forward-line -1))
1568 (if (bobp)
1569 (user-error "No previous bookmark")
1570 (forward-line -1))
1571 (setq bookmark (get-text-property (line-beginning-position)
1572 'eww-bookmark)))
1573 (eww-browse-url (plist-get bookmark :url))))
1575 (defvar eww-bookmark-mode-map
1576 (let ((map (make-sparse-keymap)))
1577 (suppress-keymap map)
1578 (define-key map "q" 'quit-window)
1579 (define-key map [(control k)] 'eww-bookmark-kill)
1580 (define-key map [(control y)] 'eww-bookmark-yank)
1581 (define-key map "\r" 'eww-bookmark-browse)
1583 (easy-menu-define nil map
1584 "Menu for `eww-bookmark-mode-map'."
1585 '("Eww Bookmark"
1586 ["Exit" quit-window t]
1587 ["Browse" eww-bookmark-browse
1588 :active (get-text-property (line-beginning-position) 'eww-bookmark)]
1589 ["Kill" eww-bookmark-kill
1590 :active (get-text-property (line-beginning-position) 'eww-bookmark)]
1591 ["Yank" eww-bookmark-yank
1592 :active eww-bookmark-kill-ring]))
1593 map))
1595 (define-derived-mode eww-bookmark-mode nil "eww bookmarks"
1596 "Mode for listing bookmarks.
1598 \\{eww-bookmark-mode-map}"
1599 (buffer-disable-undo)
1600 (setq buffer-read-only t
1601 truncate-lines t))
1603 ;;; History code
1605 (defun eww-save-history ()
1606 (plist-put eww-data :point (point))
1607 (plist-put eww-data :text (buffer-string))
1608 (push eww-data eww-history)
1609 (setq eww-data (list :title ""))
1610 ;; Don't let the history grow infinitely. We store quite a lot of
1611 ;; data per page.
1612 (when-let (tail (and eww-history-limit
1613 (nthcdr eww-history-limit eww-history)))
1614 (setcdr tail nil)))
1616 (defvar eww-current-buffer)
1618 (defun eww-list-histories ()
1619 "List the eww-histories."
1620 (interactive)
1621 (when (null eww-history)
1622 (error "No eww-histories are defined"))
1623 (let ((eww-history-trans eww-history)
1624 (buffer (current-buffer)))
1625 (set-buffer (get-buffer-create "*eww history*"))
1626 (eww-history-mode)
1627 (setq-local eww-current-buffer buffer)
1628 (let ((inhibit-read-only t)
1629 (domain-length 0)
1630 (title-length 0)
1631 url title format start)
1632 (erase-buffer)
1633 (dolist (history eww-history-trans)
1634 (setq start (point))
1635 (setq domain-length (max domain-length (length (plist-get history :url))))
1636 (setq title-length (max title-length (length (plist-get history :title)))))
1637 (setq format (format "%%-%ds %%-%ds" title-length domain-length)
1638 header-line-format
1639 (concat " " (format format "Title" "URL")))
1640 (dolist (history eww-history-trans)
1641 (setq start (point))
1642 (setq url (plist-get history :url))
1643 (setq title (plist-get history :title))
1644 (insert (format format title url))
1645 (insert "\n")
1646 (put-text-property start (1+ start) 'eww-history history))
1647 (goto-char (point-min)))
1648 (pop-to-buffer "*eww history*")))
1650 (defun eww-history-browse ()
1651 "Browse the history under point in eww."
1652 (interactive)
1653 (let ((history (get-text-property (line-beginning-position) 'eww-history)))
1654 (unless history
1655 (error "No history on the current line"))
1656 (let ((buffer eww-current-buffer))
1657 (quit-window)
1658 (when buffer
1659 (switch-to-buffer buffer)))
1660 (eww-restore-history history)))
1662 (defvar eww-history-mode-map
1663 (let ((map (make-sparse-keymap)))
1664 (suppress-keymap map)
1665 (define-key map "q" 'quit-window)
1666 (define-key map "\r" 'eww-history-browse)
1667 ;; (define-key map "n" 'next-error-no-select)
1668 ;; (define-key map "p" 'previous-error-no-select)
1670 (easy-menu-define nil map
1671 "Menu for `eww-history-mode-map'."
1672 '("Eww History"
1673 ["Exit" quit-window t]
1674 ["Browse" eww-history-browse
1675 :active (get-text-property (line-beginning-position) 'eww-history)]))
1676 map))
1678 (define-derived-mode eww-history-mode nil "eww history"
1679 "Mode for listing eww-histories.
1681 \\{eww-history-mode-map}"
1682 (buffer-disable-undo)
1683 (setq buffer-read-only t
1684 truncate-lines t))
1686 ;;; eww buffers list
1688 (defun eww-list-buffers ()
1689 "Enlist eww buffers."
1690 (interactive)
1691 (let (buffers-info
1692 (current (current-buffer)))
1693 (dolist (buffer (buffer-list))
1694 (with-current-buffer buffer
1695 (when (derived-mode-p 'eww-mode)
1696 (push (vector buffer (plist-get eww-data :title)
1697 (plist-get eww-data :url))
1698 buffers-info))))
1699 (unless buffers-info
1700 (error "No eww buffers"))
1701 (setq buffers-info (nreverse buffers-info)) ;more recent on top
1702 (set-buffer (get-buffer-create "*eww buffers*"))
1703 (eww-buffers-mode)
1704 (let ((inhibit-read-only t)
1705 (domain-length 0)
1706 (title-length 0)
1707 url title format start)
1708 (erase-buffer)
1709 (dolist (buffer-info buffers-info)
1710 (setq title-length (max title-length
1711 (length (elt buffer-info 1)))
1712 domain-length (max domain-length
1713 (length (elt buffer-info 2)))))
1714 (setq format (format "%%-%ds %%-%ds" title-length domain-length)
1715 header-line-format
1716 (concat " " (format format "Title" "URL")))
1717 (let ((line 0)
1718 (current-buffer-line 1))
1719 (dolist (buffer-info buffers-info)
1720 (setq start (point)
1721 title (elt buffer-info 1)
1722 url (elt buffer-info 2)
1723 line (1+ line))
1724 (insert (format format title url))
1725 (insert "\n")
1726 (let ((buffer (elt buffer-info 0)))
1727 (put-text-property start (1+ start) 'eww-buffer
1728 buffer)
1729 (when (eq current buffer)
1730 (setq current-buffer-line line))))
1731 (goto-char (point-min))
1732 (forward-line (1- current-buffer-line)))))
1733 (pop-to-buffer "*eww buffers*"))
1735 (defun eww-buffer-select ()
1736 "Switch to eww buffer."
1737 (interactive)
1738 (let ((buffer (get-text-property (line-beginning-position)
1739 'eww-buffer)))
1740 (unless buffer
1741 (error "No buffer on current line"))
1742 (quit-window)
1743 (switch-to-buffer buffer)))
1745 (defun eww-buffer-show ()
1746 "Display buffer under point in eww buffer list."
1747 (let ((buffer (get-text-property (line-beginning-position)
1748 'eww-buffer)))
1749 (unless buffer
1750 (error "No buffer on current line"))
1751 (other-window -1)
1752 (switch-to-buffer buffer)
1753 (other-window 1)))
1755 (defun eww-buffer-show-next ()
1756 "Move to next eww buffer in the list and display it."
1757 (interactive)
1758 (forward-line)
1759 (when (eobp)
1760 (goto-char (point-min)))
1761 (eww-buffer-show))
1763 (defun eww-buffer-show-previous ()
1764 "Move to previous eww buffer in the list and display it."
1765 (interactive)
1766 (beginning-of-line)
1767 (when (bobp)
1768 (goto-char (point-max)))
1769 (forward-line -1)
1770 (eww-buffer-show))
1772 (defun eww-buffer-kill ()
1773 "Kill buffer from eww list."
1774 (interactive)
1775 (let* ((start (line-beginning-position))
1776 (buffer (get-text-property start 'eww-buffer))
1777 (inhibit-read-only t))
1778 (unless buffer
1779 (user-error "No buffer on the current line"))
1780 (kill-buffer buffer)
1781 (forward-line 1)
1782 (delete-region start (point)))
1783 (when (eobp)
1784 (forward-line -1))
1785 (eww-buffer-show))
1787 (defvar eww-buffers-mode-map
1788 (let ((map (make-sparse-keymap)))
1789 (suppress-keymap map)
1790 (define-key map "q" 'quit-window)
1791 (define-key map [(control k)] 'eww-buffer-kill)
1792 (define-key map "\r" 'eww-buffer-select)
1793 (define-key map "n" 'eww-buffer-show-next)
1794 (define-key map "p" 'eww-buffer-show-previous)
1796 (easy-menu-define nil map
1797 "Menu for `eww-buffers-mode-map'."
1798 '("Eww Buffers"
1799 ["Exit" quit-window t]
1800 ["Select" eww-buffer-select
1801 :active (get-text-property (line-beginning-position) 'eww-buffer)]
1802 ["Kill" eww-buffer-kill
1803 :active (get-text-property (line-beginning-position) 'eww-buffer)]))
1804 map))
1806 (define-derived-mode eww-buffers-mode nil "eww buffers"
1807 "Mode for listing buffers.
1809 \\{eww-buffers-mode-map}"
1810 (buffer-disable-undo)
1811 (setq buffer-read-only t
1812 truncate-lines t))
1814 ;;; Desktop support
1816 (defvar eww-desktop-data-save
1817 '(:url :title :point)
1818 "List of `eww-data' properties to preserve in the desktop file.
1819 Also used when saving `eww-history'.")
1821 (defun eww-desktop-data-1 (alist)
1822 (let ((acc nil)
1823 (tail alist))
1824 (while tail
1825 (let ((k (car tail))
1826 (v (cadr tail)))
1827 (when (memq k eww-desktop-data-save)
1828 (setq acc (cons k (cons v acc)))))
1829 (setq tail (cddr tail)))
1830 acc))
1832 (defun eww-desktop-history-duplicate (a b)
1833 (let ((tail a) (r t))
1834 (while tail
1835 (if (or (memq (car tail) '(:point)) ; ignore :point
1836 (equal (cadr tail)
1837 (plist-get b (car tail))))
1838 (setq tail (cddr tail))
1839 (setq tail nil
1840 r nil)))
1841 ;; .
1844 (defun eww-desktop-misc-data (directory)
1845 "Return a property list with data used to restore eww buffers.
1846 This list will contain, as :history, the list, whose first element is
1847 the value of `eww-data', and the tail is `eww-history'.
1849 If `eww-desktop-remove-duplicates' is non-nil, duplicate
1850 entries (if any) will be removed from the list.
1852 Only the properties listed in `eww-desktop-data-save' are included.
1853 Generally, the list should not include the (usually overly large)
1854 :dom, :source and :text properties."
1855 (let ((history (mapcar 'eww-desktop-data-1
1856 (cons eww-data eww-history))))
1857 (list :history (if eww-desktop-remove-duplicates
1858 (cl-remove-duplicates
1859 history :test 'eww-desktop-history-duplicate)
1860 history))))
1862 (defun eww-restore-desktop (file-name buffer-name misc-data)
1863 "Restore an eww buffer from its desktop file record.
1864 If `eww-restore-desktop' is t or 'auto, this function will also
1865 initiate the retrieval of the respective URI in the background.
1866 Otherwise, the restored buffer will contain a prompt to do so by using
1867 \\[eww-reload]."
1868 (with-current-buffer (get-buffer-create buffer-name)
1869 (eww-mode)
1870 ;; NB: eww-history, eww-data are buffer-local per (eww-mode)
1871 (setq eww-history (cdr (plist-get misc-data :history))
1872 eww-data (or (car (plist-get misc-data :history))
1873 ;; backwards compatibility
1874 (list :url (plist-get misc-data :uri))))
1875 (unless file-name
1876 (when (plist-get eww-data :url)
1877 (case eww-restore-desktop
1878 ((t auto) (eww (plist-get eww-data :url)))
1879 ((zerop (buffer-size))
1880 (insert (substitute-command-keys
1881 eww-restore-reload-prompt))))))
1882 ;; .
1883 (current-buffer)))
1885 (add-to-list 'desktop-locals-to-save
1886 'eww-history-position)
1887 (add-to-list 'desktop-buffer-mode-handlers
1888 '(eww-mode . eww-restore-desktop))
1890 ;;; Isearch support
1892 (defun eww-isearch-next-buffer (&optional buffer wrap)
1893 "Go to the next page to search using `rel' attribute for navigation."
1894 (if wrap
1895 (condition-case nil
1896 (eww-top-url)
1897 (error nil))
1898 (if isearch-forward
1899 (eww-next-url)
1900 (eww-previous-url)))
1901 (current-buffer))
1903 (provide 'eww)
1905 ;;; eww.el ends here