annotate lisp/url/url-nfs.el @ 73643:b99336492688

(custom-unlispify-menu-entries, custom-unlispify-tag-names, custom-prompt-variable): Use "non-nil" in docstrings.
author Juanma Barranquero <lekktu@gmail.com>
date Fri, 03 Nov 2006 15:06:26 +0000
parents e8a3fb527b77
children e3694f1cb928 d04d8ccb3c41
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
54695
3fb37923e567 Initial revision
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
1 ;;; url-nfs.el --- NFS URL interface
54934
2fc584798d79 (url-nfs-file-attributes): Add id-format parameter.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 54770
diff changeset
2
64748
875dcc490074 Update years in copyright notice; nfc.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 64084
diff changeset
3 ;; Copyright (C) 1996, 1997, 1998, 1999, 2004,
68640
e8a3fb527b77 Update years in copyright notice; nfc.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 66225
diff changeset
4 ;; 2005, 2006 Free Software Foundation, Inc.
54934
2fc584798d79 (url-nfs-file-attributes): Add id-format parameter.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 54770
diff changeset
5
54695
3fb37923e567 Initial revision
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
6 ;; Keywords: comm, data, processes
3fb37923e567 Initial revision
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
7
54934
2fc584798d79 (url-nfs-file-attributes): Add id-format parameter.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 54770
diff changeset
8 ;; This file is part of GNU Emacs.
2fc584798d79 (url-nfs-file-attributes): Add id-format parameter.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 54770
diff changeset
9 ;;
2fc584798d79 (url-nfs-file-attributes): Add id-format parameter.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 54770
diff changeset
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
2fc584798d79 (url-nfs-file-attributes): Add id-format parameter.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 54770
diff changeset
11 ;; it under the terms of the GNU General Public License as published by
2fc584798d79 (url-nfs-file-attributes): Add id-format parameter.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 54770
diff changeset
12 ;; the Free Software Foundation; either version 2, or (at your option)
2fc584798d79 (url-nfs-file-attributes): Add id-format parameter.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 54770
diff changeset
13 ;; any later version.
2fc584798d79 (url-nfs-file-attributes): Add id-format parameter.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 54770
diff changeset
14 ;;
2fc584798d79 (url-nfs-file-attributes): Add id-format parameter.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 54770
diff changeset
15 ;; GNU Emacs is distributed in the hope that it will be useful,
2fc584798d79 (url-nfs-file-attributes): Add id-format parameter.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 54770
diff changeset
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
2fc584798d79 (url-nfs-file-attributes): Add id-format parameter.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 54770
diff changeset
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
2fc584798d79 (url-nfs-file-attributes): Add id-format parameter.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 54770
diff changeset
18 ;; GNU General Public License for more details.
2fc584798d79 (url-nfs-file-attributes): Add id-format parameter.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 54770
diff changeset
19 ;;
2fc584798d79 (url-nfs-file-attributes): Add id-format parameter.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 54770
diff changeset
20 ;; You should have received a copy of the GNU General Public License
2fc584798d79 (url-nfs-file-attributes): Add id-format parameter.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 54770
diff changeset
21 ;; along with GNU Emacs; see the file COPYING. If not, write to the
64084
a8fa7c632ee4 Update FSF's address.
Lute Kamstra <lute@gnu.org>
parents: 57886
diff changeset
22 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
a8fa7c632ee4 Update FSF's address.
Lute Kamstra <lute@gnu.org>
parents: 57886
diff changeset
23 ;; Boston, MA 02110-1301, USA.
54934
2fc584798d79 (url-nfs-file-attributes): Add id-format parameter.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 54770
diff changeset
24
2fc584798d79 (url-nfs-file-attributes): Add id-format parameter.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 54770
diff changeset
25 ;;; Commentary:
2fc584798d79 (url-nfs-file-attributes): Add id-format parameter.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 54770
diff changeset
26
2fc584798d79 (url-nfs-file-attributes): Add id-format parameter.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 54770
diff changeset
27 ;;; Code:
54695
3fb37923e567 Initial revision
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
28
3fb37923e567 Initial revision
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
29 (eval-when-compile (require 'cl))
3fb37923e567 Initial revision
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
30 (require 'url-parse)
3fb37923e567 Initial revision
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
31 (require 'url-file)
3fb37923e567 Initial revision
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
32
3fb37923e567 Initial revision
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
33 (defvar url-nfs-automounter-directory-spec
3fb37923e567 Initial revision
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
34 "file:/net/%h%f"
3fb37923e567 Initial revision
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
35 "*How to invoke the NFS automounter. Certain % sequences are recognized.
3fb37923e567 Initial revision
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
36
3fb37923e567 Initial revision
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
37 %h -- the hostname of the NFS server
3fb37923e567 Initial revision
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
38 %n -- the port # of the NFS server
3fb37923e567 Initial revision
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
39 %u -- the username to use to authenticate
3fb37923e567 Initial revision
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
40 %p -- the password to use to authenticate
3fb37923e567 Initial revision
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
41 %f -- the filename on the remote server
3fb37923e567 Initial revision
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
42 %% -- a literal %
3fb37923e567 Initial revision
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
43
3fb37923e567 Initial revision
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
44 Each can be used any number of times.")
3fb37923e567 Initial revision
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
45
3fb37923e567 Initial revision
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
46 (defun url-nfs-unescape (format host port user pass file)
3fb37923e567 Initial revision
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
47 (save-excursion
3fb37923e567 Initial revision
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
48 (set-buffer (get-buffer-create " *nfs-parse*"))
3fb37923e567 Initial revision
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
49 (erase-buffer)
3fb37923e567 Initial revision
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
50 (insert format)
3fb37923e567 Initial revision
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
51 (goto-char (point-min))
3fb37923e567 Initial revision
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
52 (while (re-search-forward "%\\(.\\)" nil t)
3fb37923e567 Initial revision
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
53 (let ((escape (aref (match-string 1) 0)))
3fb37923e567 Initial revision
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
54 (replace-match "" t t)
3fb37923e567 Initial revision
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
55 (case escape
3fb37923e567 Initial revision
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
56 (?% (insert "%"))
3fb37923e567 Initial revision
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
57 (?h (insert host))
3fb37923e567 Initial revision
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
58 (?n (insert (or port "")))
3fb37923e567 Initial revision
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
59 (?u (insert (or user "")))
3fb37923e567 Initial revision
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
60 (?p (insert (or pass "")))
3fb37923e567 Initial revision
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
61 (?f (insert (or file "/"))))))
3fb37923e567 Initial revision
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
62 (buffer-string)))
3fb37923e567 Initial revision
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
63
3fb37923e567 Initial revision
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
64 (defun url-nfs-build-filename (url)
3fb37923e567 Initial revision
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
65 (let* ((host (url-host url))
57886
60d07d8a52e1 * url-imap.el (url-imap-open-host): Don't use
Masatake YAMATO <jet@gyve.org>
parents: 57427
diff changeset
66 (port (url-port url))
54695
3fb37923e567 Initial revision
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
67 (pass (url-password url))
3fb37923e567 Initial revision
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
68 (user (url-user url))
3fb37923e567 Initial revision
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
69 (file (url-filename url)))
3fb37923e567 Initial revision
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
70 (url-generic-parse-url
3fb37923e567 Initial revision
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
71 (url-nfs-unescape url-nfs-automounter-directory-spec
3fb37923e567 Initial revision
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
72 host port user pass file))))
3fb37923e567 Initial revision
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
73
3fb37923e567 Initial revision
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
74 (defun url-nfs (url callback cbargs)
3fb37923e567 Initial revision
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
75 (url-file (url-nfs-build-filename url) callback cbargs))
3fb37923e567 Initial revision
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
76
3fb37923e567 Initial revision
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
77 (defmacro url-nfs-create-wrapper (method args)
54934
2fc584798d79 (url-nfs-file-attributes): Add id-format parameter.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 54770
diff changeset
78 `(defun ,(intern (format "url-nfs-%s" method)) ,args
2fc584798d79 (url-nfs-file-attributes): Add id-format parameter.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 54770
diff changeset
79 ,(format "NFS URL wrapper around `%s' call." method)
2fc584798d79 (url-nfs-file-attributes): Add id-format parameter.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 54770
diff changeset
80 (setq url (url-nfs-build-filename url))
2fc584798d79 (url-nfs-file-attributes): Add id-format parameter.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 54770
diff changeset
81 (and url (,(intern (format "url-file-%s" method))
2fc584798d79 (url-nfs-file-attributes): Add id-format parameter.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 54770
diff changeset
82 ,@(remove '&rest (remove '&optional args))))))
54695
3fb37923e567 Initial revision
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
83
3fb37923e567 Initial revision
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
84 (url-nfs-create-wrapper file-exists-p (url))
54934
2fc584798d79 (url-nfs-file-attributes): Add id-format parameter.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 54770
diff changeset
85 (url-nfs-create-wrapper file-attributes (url &optional id-format))
54695
3fb37923e567 Initial revision
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
86 (url-nfs-create-wrapper file-symlink-p (url))
3fb37923e567 Initial revision
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
87 (url-nfs-create-wrapper file-readable-p (url))
3fb37923e567 Initial revision
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
88 (url-nfs-create-wrapper file-writable-p (url))
3fb37923e567 Initial revision
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
89 (url-nfs-create-wrapper file-executable-p (url))
66225
eb65acc95303 Remove XEmacs conditionals.
Eli Zaretskii <eliz@gnu.org>
parents: 64748
diff changeset
90 (url-nfs-create-wrapper directory-files (url &optional full match nosort))
eb65acc95303 Remove XEmacs conditionals.
Eli Zaretskii <eliz@gnu.org>
parents: 64748
diff changeset
91 (url-nfs-create-wrapper file-truename (url &optional counter prev-dirs))
54695
3fb37923e567 Initial revision
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
92
3fb37923e567 Initial revision
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
diff changeset
93 (provide 'url-nfs)
54699
7784ae10206d Resolve CVS conflicts
Miles Bader <miles@gnu.org>
parents: 54695
diff changeset
94
54934
2fc584798d79 (url-nfs-file-attributes): Add id-format parameter.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 54770
diff changeset
95 ;; arch-tag: cdf9c9ba-b7d2-4c29-8b48-7ae9bbc0d437
2fc584798d79 (url-nfs-file-attributes): Add id-format parameter.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 54770
diff changeset
96 ;;; url-nfs.el ends here