code.delx.au - gnu-emacs/blob - lisp/url/url-file.el

   1 ;;; url-file.el --- File retrieval code
   2
   3 ;; Copyright (C) 1996, 1997, 1998, 1999, 2004,
   4 ;;   2005, 2006, 2007 Free Software Foundation, Inc.
   5
   6 ;; Keywords: comm, data, processes
   7
   8 ;; This file is part of GNU Emacs.
   9 ;;
  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, or (at your option)
  13 ;; any later version.
  14 ;;
  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.
  19 ;;
  20 ;; You should have received a copy of the GNU General Public License
  21 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  22 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  23 ;; Boston, MA 02110-1301, USA.
  24
  25 ;;; Commentary:
  26
  27 ;;; Code:
  28
  29 (eval-when-compile (require 'cl))
  30 (require 'mailcap)
  31 (require 'url-vars)
  32 (require 'url-parse)
  33 (require 'url-dired)
  34
  35 (defconst url-file-default-port 21 "Default FTP port.")
  36 (defconst url-file-asynchronous-p t "FTP transfers are asynchronous.")
  37 (defalias 'url-file-expand-file-name 'url-default-expander)
  38
  39 (defun url-file-find-possibly-compressed-file (fname &rest args)
  40   "Find the exact file referenced by `fname'.
  41 This tries the common compression extensions, because things like
  42 ange-ftp and efs are not quite smart enough to realize when a server
  43 can do automatic decompression for them, and won't find 'foo' if
  44 'foo.gz' exists, even though the ftp server would happily serve it up
  45 to them."
  46   (let ((scratch nil)
  47         (compressed-extensions '("" ".gz" ".z" ".Z" ".bz2"))
  48         (found nil))
  49     (while (and compressed-extensions (not found))
  50       (if (file-exists-p (setq scratch (concat fname (pop compressed-extensions))))
  51           (setq found scratch)))
  52     found))
  53
  54 (defun url-file-host-is-local-p (host)
  55   "Return t if HOST references our local machine."
  56   (let ((case-fold-search t))
  57     (or
  58      (null host)
  59      (string= "" host)
  60      (equal (downcase host) (downcase (system-name)))
  61      (and (string-match "^localhost$" host) t)
  62      (and (not (string-match (regexp-quote ".") host))
  63           (equal (downcase host) (if (string-match (regexp-quote ".")
  64                                                    (system-name))
  65                                      (substring (system-name) 0
  66                                                 (match-beginning 0))
  67                                    (system-name)))))))
  68
  69 (defun url-file-asynch-callback (x y name buff func args &optional efs)
  70   (if (not (featurep 'ange-ftp))
  71       ;; EFS passes us an extra argument
  72       (setq name buff
  73             buff func
  74             func args
  75             args efs))
  76   (let ((size (nth 7 (file-attributes name))))
  77     (with-current-buffer buff
  78       (goto-char (point-max))
  79       (if (/= -1 size)
  80           (insert (format "Content-length: %d\n" size)))
  81       (insert "\n")
  82       (insert-file-contents-literally name)
  83       (if (not (url-file-host-is-local-p (url-host url-current-object)))
  84           (condition-case ()
  85               (delete-file name)
  86             (error nil)))
  87       (apply func args))))
  88
  89 (defun url-file-build-filename (url)
  90   (if (not (vectorp url))
  91       (setq url (url-generic-parse-url url)))
  92   (let* ((user (url-user url))
  93          (pass (url-password url))
  94          (port (url-port url))
  95          (host (url-host url))
  96          (site (if (and port (/= port 21))
  97                    (if (featurep 'ange-ftp)
  98                        (format "%s %d" host port)
  99                      ;; This works in Emacs 21's ange-ftp too.
 100                      (format "%s#%d" host port))
 101                  host))
 102          (file (url-unhex-string (url-filename url)))
 103          (filename (if (or user (not (url-file-host-is-local-p host)))
 104                        (concat "/" (or user "anonymous") "@" site ":" file)
 105                      (if (and (memq system-type
 106                                     '(emx ms-dos windows-nt ms-windows))
 107                               (string-match "^/[a-zA-Z]:/" file))
 108                          (substring file 1)
 109                        file)))
 110          pos-index)
 111
 112     (and user pass
 113          (cond
 114           ((featurep 'ange-ftp)
 115            (ange-ftp-set-passwd host user pass))
 116           ((or (featurep 'efs) (featurep 'efs-auto))
 117            (efs-set-passwd host user pass))
 118           (t
 119            nil)))
 120
 121     ;; This makes sure that directories have a trailing directory
 122     ;; separator on them so URL expansion works right.
 123     ;;
 124     ;; FIXME?  What happens if the remote system doesn't use our local
 125     ;; directory-sep-char as its separator?  Would it be safer to just
 126     ;; use '/' unconditionally and rely on the FTP server to
 127     ;; straighten it out for us?
 128     ;; (if (and (file-directory-p filename)
 129     ;;          (not (string-match (format "%c$" directory-sep-char) filename)))
 130     ;;     (setf (url-filename url)
 131     ;;           (format "%s%c" filename directory-sep-char)))
 132     (if (and (file-directory-p filename)
 133              (not (string-match "/\\'" filename)))
 134         (setf (url-filename url) (format "%s/" filename)))
 135
 136
 137     ;; If it is a directory, look for an index file first.
 138     (if (and (file-directory-p filename)
 139              url-directory-index-file
 140              (setq pos-index (expand-file-name url-directory-index-file filename))
 141              (file-exists-p pos-index)
 142              (file-readable-p pos-index))
 143         (setq filename pos-index))
 144
 145     ;; Find the (possibly compressed) file
 146     (setq filename (url-file-find-possibly-compressed-file filename))
 147     filename))
 148
 149 ;;;###autoload
 150 (defun url-file (url callback cbargs)
 151   "Handle file: and ftp: URLs."
 152   (let* ((buffer nil)
 153          (uncompressed-filename nil)
 154          (content-type nil)
 155          (content-encoding nil)
 156          (coding-system-for-read 'binary))
 157
 158     (setq filename (url-file-build-filename url))
 159
 160     (if (not filename)
 161         (error "File does not exist: %s" (url-recreate-url url)))
 162
 163     ;; Need to figure out the content-type from the real extension,
 164     ;; not the compressed one.
 165     (setq uncompressed-filename (if (string-match "\\.\\(gz\\|Z\\|z\\)$" filename)
 166                                     (substring filename 0 (match-beginning 0))
 167                                   filename))
 168     (setq content-type (mailcap-extension-to-mime
 169                         (url-file-extension uncompressed-filename))
 170           content-encoding (case (intern (url-file-extension filename))
 171                              ((\.z \.gz) "gzip")
 172                              (\.Z "compress")
 173                              (\.uue "x-uuencoded")
 174                              (\.hqx "x-hqx")
 175                              (\.bz2 "x-bzip2")
 176                              (otherwise nil)))
 177
 178     (if (file-directory-p filename)
 179         ;; A directory is done the same whether we are local or remote
 180         (url-find-file-dired filename)
 181       (with-current-buffer
 182           (setq buffer (generate-new-buffer " *url-file*"))
 183         (mm-disable-multibyte)
 184         (setq url-current-object url)
 185         (insert "Content-type: " (or content-type "application/octet-stream") "\n")
 186         (if content-encoding
 187             (insert "Content-transfer-encoding: " content-encoding "\n"))
 188         (if (url-file-host-is-local-p (url-host url))
 189               ;; Local files are handled slightly oddly
 190             (if (featurep 'ange-ftp)
 191                 (url-file-asynch-callback nil nil
 192                                           filename
 193                                           (current-buffer)
 194                                           callback cbargs)
 195               (url-file-asynch-callback nil nil nil
 196                                         filename
 197                                         (current-buffer)
 198                                         callback cbargs))
 199           ;; FTP handling
 200           (let* ((extension (url-file-extension filename))
 201                  (new (url-generate-unique-filename
 202                        (and (> (length extension) 0)
 203                             (concat "%s." extension)))))
 204             (if (featurep 'ange-ftp)
 205                 (ange-ftp-copy-file-internal filename (expand-file-name new) t
 206                                              nil t
 207                                              (list 'url-file-asynch-callback
 208                                                    new (current-buffer)
 209                                                    callback cbargs)
 210                                              t)
 211               (autoload 'efs-copy-file-internal "efs")
 212               (efs-copy-file-internal filename (efs-ftp-path filename)
 213                                       new (efs-ftp-path new)
 214                                       t nil 0
 215                                       (list 'url-file-asynch-callback
 216                                             new (current-buffer)
 217                                             callback cbargs)
 218                                       0 nil))))))
 219     buffer))
 220
 221 (defmacro url-file-create-wrapper (method args)
 222   `(defalias ',(intern (format "url-ftp-%s" method))
 223      (defun ,(intern (format "url-file-%s" method)) ,args
 224        ,(format "FTP/FILE URL wrapper around `%s' call." method)
 225        (setq url (url-file-build-filename url))
 226        (and url (,method ,@(remove '&rest (remove '&optional args)))))))
 227
 228 (url-file-create-wrapper file-exists-p (url))
 229 (url-file-create-wrapper file-attributes (url &optional id-format))
 230 (url-file-create-wrapper file-symlink-p (url))
 231 (url-file-create-wrapper file-readable-p (url))
 232 (url-file-create-wrapper file-writable-p (url))
 233 (url-file-create-wrapper file-executable-p (url))
 234 (url-file-create-wrapper directory-files (url &optional full match nosort))
 235 (url-file-create-wrapper file-truename (url &optional counter prev-dirs))
 236
 237 (provide 'url-file)
 238
 239 ;; arch-tag: 010e914a-7313-494b-8a8c-6495a862157d
 240 ;;; url-file.el ends here