dnd.el 8.35 KB
Newer Older
1
;;; dnd.el --- drag and drop support
Jan Djärv's avatar
Jan Djärv committed
2

Paul Eggert's avatar
Paul Eggert committed
3
;; Copyright (C) 2005-2019 Free Software Foundation, Inc.
Jan Djärv's avatar
Jan Djärv committed
4

5
;; Author: Jan Djärv <jan.h.d@swipnet.se>
6
;; Maintainer: emacs-devel@gnu.org
Jan Djärv's avatar
Jan Djärv committed
7
;; Keywords: window, drag, drop
8
;; Package: emacs
Jan Djärv's avatar
Jan Djärv committed
9 10 11

;; This file is part of GNU Emacs.

12
;; GNU Emacs is free software: you can redistribute it and/or modify
Jan Djärv's avatar
Jan Djärv committed
13
;; it under the terms of the GNU General Public License as published by
14 15
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
Jan Djärv's avatar
Jan Djärv committed
16 17 18 19 20 21 22

;; 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
23
;; along with GNU Emacs.  If not, see <https://www.gnu.org/licenses/>.
Jan Djärv's avatar
Jan Djärv committed
24 25 26 27 28 29 30 31 32 33 34 35 36

;;; Commentary:

;; This file provides the generic handling of the drop part only.
;; Different DND backends (X11, W32, etc.) that handle the platform
;; specific DND parts call the functions here to do final delivery of
;; a drop.

;;; Code:

;;; Customizable variables


37
;;;###autoload
Jan Djärv's avatar
Jan Djärv committed
38
(defcustom dnd-protocol-alist
39 40 41 42
  `((,(purecopy "^file:///")  . dnd-open-local-file)	; XDND format.
    (,(purecopy "^file://")   . dnd-open-file)		; URL with host
    (,(purecopy "^file:")     . dnd-open-local-file)	; Old KDE, Motif, Sun
    (,(purecopy "^\\(https?\\|ftp\\|file\\|nfs\\)://") . dnd-open-file)
43
   )
Jan Djärv's avatar
Jan Djärv committed
44 45 46 47 48 49 50 51 52 53 54 55 56

  "The functions to call for different protocols when a drop is made.
This variable is used by `dnd-handle-one-url' and `dnd-handle-file-name'.
The list contains of (REGEXP . FUNCTION) pairs.
The functions shall take two arguments, URL, which is the URL dropped and
ACTION which is the action to be performed for the drop (move, copy, link,
private or ask).
If no match is found here, and the value of `browse-url-browser-function'
is a pair of (REGEXP . FUNCTION), those regexps are tried for a match.
If no match is found, the URL is inserted as text by calling `dnd-insert-text'.
The function shall return the action done (move, copy, link or private)
if some action was made, or nil if the URL is ignored."
  :version "22.1"
57
  :type '(repeat (cons (regexp) (function)))
Jan Djärv's avatar
Jan Djärv committed
58 59 60
  :group 'dnd)


61 62
(defcustom dnd-open-remote-file-function
  (if (eq system-type 'windows-nt)
63
      'dnd-open-local-file
64 65 66 67 68
    'dnd-open-remote-url)
  "The function to call when opening a file on a remote machine.
The function will be called with two arguments; URI and ACTION. See
`dnd-open-file' for details.
If nil, then dragging remote files into Emacs will result in an error.
69 70 71 72
Predefined functions are `dnd-open-local-file' and `dnd-open-remote-url'.
`dnd-open-local-file' attempts to open a remote file using its UNC name and
is the  default on MS-Windows.  `dnd-open-remote-url' uses `url-handler-mode'
and is the default except for MS-Windows."
73 74 75 76
  :version "22.1"
  :type 'function
  :group 'dnd)

Jan Djärv's avatar
Jan Djärv committed
77 78 79 80 81 82 83 84 85 86

(defcustom dnd-open-file-other-window nil
  "If non-nil, always use find-file-other-window to open dropped files."
  :version "22.1"
  :type 'boolean
  :group 'dnd)


;; Functions

87
(defun dnd-handle-one-url (window action url)
Jan Djärv's avatar
Jan Djärv committed
88 89 90 91 92
  "Handle one dropped url by calling the appropriate handler.
The handler is first located by looking at `dnd-protocol-alist'.
If no match is found here, and the value of `browse-url-browser-function'
is a pair of (REGEXP . FUNCTION), those regexps are tried for a match.
If no match is found, just call `dnd-insert-text'.
93
WINDOW is where the drop happened, ACTION is the action for the drop,
94
URL is what has been dropped.
Jan Djärv's avatar
Jan Djärv committed
95 96
Returns ACTION."
  (require 'browse-url)
97
  (let (ret)
Jan Djärv's avatar
Jan Djärv committed
98 99 100
    (or
     (catch 'done
       (dolist (bf dnd-protocol-alist)
101 102
	 (when (string-match (car bf) url)
	   (setq ret (funcall (cdr bf) url action))
Jan Djärv's avatar
Jan Djärv committed
103 104 105 106 107
	   (throw 'done t)))
       nil)
     (when (not (functionp browse-url-browser-function))
       (catch 'done
	 (dolist (bf browse-url-browser-function)
108
	   (when (string-match (car bf) url)
Jan Djärv's avatar
Jan Djärv committed
109
	     (setq ret 'private)
110
	     (funcall (cdr bf) url action)
Jan Djärv's avatar
Jan Djärv committed
111 112 113
	     (throw 'done t)))
	 nil))
     (progn
114
       (dnd-insert-text window action url)
Jan Djärv's avatar
Jan Djärv committed
115 116 117 118 119 120 121 122 123 124
       (setq ret 'private)))
    ret))


(defun dnd-get-local-file-uri (uri)
  "Return an uri converted to file:/// syntax if uri is a local file.
Return nil if URI is not a local file."

  ;; The hostname may be our hostname, in that case, convert to a local
  ;; file.  Otherwise return nil.  TODO:  How about an IP-address as hostname?
125
  (let ((sysname (system-name)))
126
    (let ((hostname (when (string-match "^file://\\([^/]*\\)" uri)
Jan Djärv's avatar
Jan Djärv committed
127
		      (downcase (match-string 1 uri))))
128 129 130 131
	  (sysname-no-dot
	   (downcase (if (string-match "^[^\\.]+" sysname)
			 (match-string 0 sysname)
		       sysname))))
132
      (when (and hostname
133
                 (not (eq system-type 'windows-nt))
134
		 (or (string-equal "localhost" hostname)
135 136
		     (string-equal (downcase sysname) hostname)
		     (string-equal sysname-no-dot hostname)))
137
	(concat "file://" (substring uri (+ 7 (length hostname))))))))
Jan Djärv's avatar
Jan Djärv committed
138

139 140
(defsubst dnd-unescape-uri (uri)
  (replace-regexp-in-string
141
   "%[[:xdigit:]][[:xdigit:]]"
142 143 144 145 146 147
   (lambda (arg)
     (let ((str (make-string 1 0)))
       (aset str 0 (string-to-number (substring arg 1) 16))
       str))
   uri t t))

148
;; https://lists.gnu.org/r/emacs-devel/2006-05/msg01060.html
Jan Djärv's avatar
Jan Djärv committed
149 150 151 152 153 154 155 156
(defun dnd-get-local-file-name (uri &optional must-exist)
  "Return file name converted from file:/// or file: syntax.
URI is the uri for the file.  If MUST-EXIST is given and non-nil,
only return non-nil if the file exists.
Return nil if URI is not a local file."
  (let ((f (cond ((string-match "^file:///" uri)	; XDND format.
		  (substring uri (1- (match-end 0))))
		 ((string-match "^file:" uri)		; Old KDE, Motif, Sun
157 158 159 160 161 162 163
		  (substring uri (match-end 0)))))
	(coding (if (equal system-type 'windows-nt)
		    ;; W32 pretends that file names are UTF-8 encoded.
		    'utf-8
		  (or file-name-coding-system
		      default-file-name-coding-system))))
    (and f (setq f (decode-coding-string (dnd-unescape-uri f) coding)))
164 165
    (when (and f must-exist (not (file-readable-p f)))
      (setq f nil))
166
    f))
Jan Djärv's avatar
Jan Djärv committed
167

168
(defun dnd-open-local-file (uri _action)
Jan Djärv's avatar
Jan Djärv committed
169 170 171 172
  "Open a local file.
The file is opened in the current window, or a new window if
`dnd-open-file-other-window' is set.  URI is the url for the file,
and must have the format file:file-name or file:///file-name.
173 174 175 176 177
The last / in file:/// is part of the file name.  If the system
natively supports unc file names, then remote urls of the form
file://server-name/file-name will also be handled by this function.
An alternative for systems that do not support unc file names is
`dnd-open-remote-url'. ACTION is ignored."
Jan Djärv's avatar
Jan Djärv committed
178 179 180 181 182 183 184 185 186 187

  (let* ((f (dnd-get-local-file-name uri t)))
    (if (and f (file-readable-p f))
	(progn
	  (if dnd-open-file-other-window
	      (find-file-other-window f)
	    (find-file f))
	  'private)
      (error "Can not read %s" uri))))

188
(defun dnd-open-remote-url (uri _action)
189 190 191 192 193
  "Open a remote file with `find-file' and `url-handler-mode'.
Turns `url-handler-mode' on if not on before.  The file is opened in the
current window, or a new window if `dnd-open-file-other-window' is set.
URI is the url for the file.  ACTION is ignored."
  (progn
Jan Djärv's avatar
Jan Djärv committed
194
    (require 'url-handlers)
195 196 197 198 199 200 201
    (or url-handler-mode (url-handler-mode))
    (if dnd-open-file-other-window
	(find-file-other-window uri)
      (find-file uri))
    'private))


Jan Djärv's avatar
Jan Djärv committed
202 203 204 205 206 207 208 209 210 211 212
(defun dnd-open-file (uri action)
  "Open a local or remote file.
The file is opened in the current window, or a new window if
`dnd-open-file-other-window' is set.  URI is the url for the file,
and must have the format file://hostname/file-name.  ACTION is ignored.
The last / in file://hostname/ is part of the file name."

  ;; The hostname may be our hostname, in that case, convert to a local
  ;; file.  Otherwise return nil.
  (let ((local-file (dnd-get-local-file-uri uri)))
    (if local-file (dnd-open-local-file local-file action)
213 214 215
      (if dnd-open-remote-file-function
	  (funcall dnd-open-remote-file-function uri action)
	(error "Remote files not supported")))))
Jan Djärv's avatar
Jan Djärv committed
216 217 218 219 220 221 222 223 224


(defun dnd-insert-text (window action text)
  "Insert text at point or push to the kill ring if buffer is read only.
TEXT is the text as a string, WINDOW is the window where the drop happened."
  (if (or buffer-read-only
	  (not (windowp window)))
      (progn
	(kill-new text)
Deepak Goel's avatar
Deepak Goel committed
225
	(message "%s"
Jan Djärv's avatar
Jan Djärv committed
226 227 228 229 230 231 232 233 234
	 (substitute-command-keys
	  "The dropped text can be accessed with \\[yank]")))
    (insert text))
  action)


(provide 'dnd)

;;; dnd.el ends here