[bpt/emacs.git] / lisp / url / url-about.el

;;; url-about.el --- Show internal URLs

;; Copyright (C) 2001, 2004, 2005, 2006, 2007, 2008, 2009, 2010
;;   Free Software Foundation, Inc.

;; Keywords: comm, data, processes, hypermedia

;; This file is part of GNU Emacs.
;;
;; GNU Emacs is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.

;;; Commentary:

;;; Code:

(require 'url-util)
(require 'url-parse)

(defun url-probe-protocols ()
  "Return a list of all potential URL schemes."
  (or (get 'url-extension-protocols 'probed)
      (mapc (lambda (s) (url-scheme-get-property s 'name))
	    (or (get 'url-extension-protocols 'schemes)
		(let ((schemes '("info" "man" "rlogin" "telnet"
				 "tn3270" "data" "snews")))
		  (mapc (lambda (d)
			  (mapc (lambda (f)
				  (if (string-match "url-\\(.*\\).el$" f)
				      (push (match-string 1 f) schemes)))
				(directory-files d nil "^url-.*\\.el$")))
			load-path)
		  (put 'url-extension-protocols 'schemes schemes)
		  schemes)))))

(defvar url-scheme-registry)

(defun url-about-protocols (url)
  (url-probe-protocols)
  (insert "<html>\n"
	  " <head>\n"
	  "  <title>Supported Protocols</title>\n"
	  " </head>\n"
	  " <body>\n"
	  "  <h1>Supported Protocols - URL v" url-version "</h1>\n"
	  "  <table width='100%' border='1'>\n"
	  "   <tr>\n"
	  "    <td>Protocol\n"
	  "    <td>Properties\n"
	  "    <td>Description\n"
	  "   </tr>\n")
  (mapc (lambda (k)
	  (if (string= k "proxy")
	      ;; Ignore the proxy setting... its magic!
	      nil
	    (insert "   <tr>\n")
	    ;; The name of the protocol
	    (insert "    <td valign=top>" (or (url-scheme-get-property k 'name) k) "\n")

	    ;; Now the properties.  Currently just asynchronous
	    ;; status, default port number, and proxy status.
	    (insert "    <td valign=top>"
		    (if (url-scheme-get-property k 'asynchronous-p) "As" "S")
		    "ynchronous<br>\n"
		    (if (url-scheme-get-property k 'default-port)
			(format "Default Port: %d<br>\n"
				(url-scheme-get-property k 'default-port)) "")
		    (if (assoc k url-proxy-services)
			(format "Proxy: %s<br>\n" (assoc k url-proxy-services)) ""))
	    ;; Now the description...
	    (insert "    <td valign=top>"
		    (or (url-scheme-get-property k 'description) "N/A"))))
	(sort (let (x) (maphash (lambda (k v) (push k x)) url-scheme-registry) x) 'string-lessp))
  (insert "  </table>\n"
	  " </body>\n"
	  "</html>\n"))

(defun url-about (url)
  "Show internal URLs."
  (let* ((item (downcase (url-filename url)))
	 (func (intern (format "url-about-%s" item))))
    (if (fboundp func)
	(progn
	  (set-buffer (generate-new-buffer " *about-data*"))
	  (insert "Content-type: text/plain\n\n")
	  (funcall func url)
	  (current-buffer))
      (error "URL does not know about `%s'" item))))

(provide 'url-about)

;; arch-tag: 65dd7fca-db3f-4cb1-8026-7dd37d4a460e
;;; url-about.el ends here
Commit	Line	Data
8c8b8430	1	;;; url-about.el --- Show internal URLs
d3c91027	2
114f9c96	3	;; Copyright (C) 2001, 2004, 2005, 2006, 2007, 2008, 2009, 2010
12dc447f	4	;; Free Software Foundation, Inc.
d3c91027	5
8c8b8430 SM	6	;; Keywords: comm, data, processes, hypermedia
8c8b8430 SM	7
d3c91027 SM	8	;; This file is part of GNU Emacs.
d3c91027 SM	9	;;
4936186e	10	;; GNU Emacs is free software: you can redistribute it and/or modify
d3c91027	11	;; it under the terms of the GNU General Public License as published by
4936186e GM	12	;; the Free Software Foundation, either version 3 of the License, or
	13	;; (at your option) any later version.
	14
d3c91027 SM	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.
4936186e	19
d3c91027	20	;; You should have received a copy of the GNU General Public License
4936186e	21	;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
d3c91027 SM	22
	23	;;; Commentary:
	24
	25	;;; Code:
	26
8c8b8430 SM	27	(require 'url-util)
	28	(require 'url-parse)
	29
	30	(defun url-probe-protocols ()
d3c91027	31	"Return a list of all potential URL schemes."
8c8b8430 SM	32	(or (get 'url-extension-protocols 'probed)
	33	(mapc (lambda (s) (url-scheme-get-property s 'name))
	34	(or (get 'url-extension-protocols 'schemes)
	35	(let ((schemes '("info" "man" "rlogin" "telnet"
	36	"tn3270" "data" "snews")))
	37	(mapc (lambda (d)
	38	(mapc (lambda (f)
	39	(if (string-match "url-\\(.*\\).el$" f)
	40	(push (match-string 1 f) schemes)))
	41	(directory-files d nil "^url-.*\\.el$")))
	42	load-path)
	43	(put 'url-extension-protocols 'schemes schemes)
	44	schemes)))))
	45
d3c91027 SM	46	(defvar url-scheme-registry)
d3c91027 SM	47
8c8b8430 SM	48	(defun url-about-protocols (url)
	49	(url-probe-protocols)
	50	(insert "<html>\n"
	51	" <head>\n"
	52	" <title>Supported Protocols</title>\n"
	53	" </head>\n"
	54	" <body>\n"
	55	" <h1>Supported Protocols - URL v" url-version "</h1>\n"
	56	" <table width='100%' border='1'>\n"
	57	" <tr>\n"
	58	" <td>Protocol\n"
	59	" <td>Properties\n"
	60	" <td>Description\n"
	61	" </tr>\n")
	62	(mapc (lambda (k)
	63	(if (string= k "proxy")
	64	;; Ignore the proxy setting... its magic!
	65	nil
	66	(insert " <tr>\n")
	67	;; The name of the protocol
	68	(insert " <td valign=top>" (or (url-scheme-get-property k 'name) k) "\n")
	69
	70	;; Now the properties. Currently just asynchronous
	71	;; status, default port number, and proxy status.
	72	(insert " <td valign=top>"
	73	(if (url-scheme-get-property k 'asynchronous-p) "As" "S")
	74	"ynchronous<br>\n"
	75	(if (url-scheme-get-property k 'default-port)
	76	(format "Default Port: %d<br>\n"
	77	(url-scheme-get-property k 'default-port)) "")
	78	(if (assoc k url-proxy-services)
	79	(format "Proxy: %s<br>\n" (assoc k url-proxy-services)) ""))
	80	;; Now the description...
	81	(insert " <td valign=top>"
	82	(or (url-scheme-get-property k 'description) "N/A"))))
	83	(sort (let (x) (maphash (lambda (k v) (push k x)) url-scheme-registry) x) 'string-lessp))
	84	(insert " </table>\n"
	85	" </body>\n"
	86	"</html>\n"))
	87
	88	(defun url-about (url)
	89	"Show internal URLs."
	90	(let* ((item (downcase (url-filename url)))
	91	(func (intern (format "url-about-%s" item))))
	92	(if (fboundp func)
	93	(progn
	94	(set-buffer (generate-new-buffer " about-data"))
d3c91027	95	(insert "Content-type: text/plain\n\n")
8c8b8430 SM	96	(funcall func url)
	97	(current-buffer))
	98	(error "URL does not know about `%s'" item))))
	99
	100	(provide 'url-about)
e5566bd5	101
d3c91027 SM	102	;; arch-tag: 65dd7fca-db3f-4cb1-8026-7dd37d4a460e
d3c91027 SM	103	;;; url-about.el ends here