54695
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
1 ;;; url-methods.el --- Load URL schemes as needed
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
2 ;; Keywords: comm, data, processes, hypermedia
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
3
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
4 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
54698
|
5 ;;; Copyright (c) 1993 - 1996, 2004 by William M. Perry <wmperry@cs.indiana.edu>
|
54695
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
6 ;;; Copyright (c) 1996 - 1999 Free Software Foundation, Inc.
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
7 ;;;
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
8 ;;; This file is part of GNU Emacs.
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
9 ;;;
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
10 ;;; GNU Emacs is free software; you can redistribute it and/or modify
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
11 ;;; it under the terms of the GNU General Public License as published by
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
12 ;;; the Free Software Foundation; either version 2, or (at your option)
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
13 ;;; any later version.
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
14 ;;;
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
15 ;;; GNU Emacs is distributed in the hope that it will be useful,
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
16 ;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
17 ;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
18 ;;; GNU General Public License for more details.
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
19 ;;;
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
20 ;;; You should have received a copy of the GNU General Public License
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
21 ;;; along with GNU Emacs; see the file COPYING. If not, write to the
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
22 ;;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
23 ;;; Boston, MA 02111-1307, USA.
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
24 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
25
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
26 (eval-when-compile
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
27 (require 'cl))
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
28
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
29 ;; This loads up some of the small, silly URLs that I really don't
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
30 ;; want to bother putting in their own separate files.
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
31 (require 'url-parse)
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
32
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
33 (defvar url-scheme-registry (make-hash-table :size 7 :test 'equal))
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
34
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
35 (defconst url-scheme-methods
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
36 '((default-port . variable)
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
37 (asynchronous-p . variable)
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
38 (expand-file-name . function)
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
39 (file-exists-p . function)
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
40 (file-attributes . function)
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
41 (parse-url . function)
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
42 (file-symlink-p . function)
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
43 (file-writable-p . function)
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
44 (file-directory-p . function)
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
45 (file-executable-p . function)
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
46 (directory-files . function)
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
47 (file-truename . function))
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
48 "Assoc-list of methods that each URL loader can provide.")
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
49
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
50 (defconst url-scheme-default-properties
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
51 (list 'name "unknown"
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
52 'loader 'url-scheme-default-loader
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
53 'default-port 0
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
54 'expand-file-name 'url-identity-expander
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
55 'parse-url 'url-generic-parse-url
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
56 'asynchronous-p nil
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
57 'file-directory-p 'ignore
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
58 'file-truename (lambda (&rest args)
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
59 (url-recreate-url (car args)))
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
60 'file-exists-p 'ignore
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
61 'file-attributes 'ignore))
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
62
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
63 (defun url-scheme-default-loader (url &optional callback cbargs)
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
64 "Signal an error for an unknown URL scheme."
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
65 (error "Unkown URL scheme: %s" (url-type url)))
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
66
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
67 (defun url-scheme-register-proxy (scheme)
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
68 "Automatically find a proxy for SCHEME and put it in `url-proxy-services'."
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
69 (let* ((env-var (concat scheme "_proxy"))
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
70 (env-proxy (or (getenv (upcase env-var))
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
71 (getenv (downcase env-var))))
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
72 (cur-proxy (assoc scheme url-proxy-services))
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
73 (urlobj nil))
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
74
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
75 ;; Store any proxying information - this will not overwrite an old
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
76 ;; entry, so that people can still set this information in their
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
77 ;; .emacs file
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
78 (cond
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
79 (cur-proxy nil) ; Keep their old settings
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
80 ((null env-proxy) nil) ; No proxy setup
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
81 ;; First check if its something like hostname:port
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
82 ((string-match "^\\([^:]+\\):\\([0-9]+\\)$" env-proxy)
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
83 (setq urlobj (url-generic-parse-url nil)) ; Get a blank object
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
84 (url-set-type urlobj "http")
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
85 (url-set-host urlobj (match-string 1 env-proxy))
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
86 (url-set-port urlobj (string-to-number (match-string 2 env-proxy))))
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
87 ;; Then check if its a fully specified URL
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
88 ((string-match url-nonrelative-link env-proxy)
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
89 (setq urlobj (url-generic-parse-url env-proxy))
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
90 (url-set-type urlobj "http")
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
91 (url-set-target urlobj nil))
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
92 ;; Finally, fall back on the assumption that its just a hostname
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
93 (t
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
94 (setq urlobj (url-generic-parse-url nil)) ; Get a blank object
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
95 (url-set-type urlobj "http")
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
96 (url-set-host urlobj env-proxy)))
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
97
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
98 (if (and (not cur-proxy) urlobj)
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
99 (progn
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
100 (setq url-proxy-services
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
101 (cons (cons scheme (format "%s:%d" (url-host urlobj)
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
102 (url-port urlobj)))
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
103 url-proxy-services))
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
104 (message "Using a proxy for %s..." scheme)))))
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
105
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
106 (defun url-scheme-get-property (scheme property)
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
107 "Get property of a URL SCHEME.
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
108 Will automatically try to load a backend from url-SCHEME.el if
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
109 it has not already been loaded."
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
110 (setq scheme (downcase scheme))
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
111 (let ((desc (gethash scheme url-scheme-registry)))
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
112 (if (not desc)
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
113 (let* ((stub (concat "url-" scheme))
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
114 (loader (intern stub)))
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
115 (condition-case ()
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
116 (require loader)
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
117 (error nil))
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
118 (if (fboundp loader)
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
119 (progn
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
120 ;; Found the module to handle <scheme> URLs
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
121 (url-scheme-register-proxy scheme)
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
122 (setq desc (list 'name scheme
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
123 'loader loader))
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
124 (dolist (cell url-scheme-methods)
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
125 (let ((symbol (intern-soft (format "%s-%s" stub (car cell))))
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
126 (type (cdr cell)))
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
127 (if symbol
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
128 (case type
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
129 (function
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
130 ;; Store the symbol name of a function
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
131 (if (fboundp symbol)
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
132 (setq desc (plist-put desc (car cell) symbol))))
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
133 (variable
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
134 ;; Store the VALUE of a variable
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
135 (if (boundp symbol)
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
136 (setq desc (plist-put desc (car cell)
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
137 (symbol-value symbol)))))
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
138 (otherwise
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
139 (error "Malformed url-scheme-methods entry: %S"
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
140 cell))))))
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
141 (puthash scheme desc url-scheme-registry)))))
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
142 (or (plist-get desc property)
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
143 (plist-get url-scheme-default-properties property))))
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
144
|
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff
changeset
|
145 (provide 'url-methods)
|
54699
|
146
|
|
147 ;;; arch-tag: 336863f8-5a07-4906-9be5-b3c6bcebbe67
|