449 lines
18 KiB
EmacsLisp
449 lines
18 KiB
EmacsLisp
;;; tramp-rclone.el --- Tramp access functions to cloud storages -*- lexical-binding:t -*-
|
||
|
||
;; Copyright (C) 2018-2024 Free Software Foundation, Inc.
|
||
|
||
;; Author: Michael Albinus <michael.albinus@gmx.de>
|
||
;; Keywords: comm, processes
|
||
;; Package: tramp
|
||
|
||
;; 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 <https://www.gnu.org/licenses/>.
|
||
|
||
;;; Commentary:
|
||
|
||
;; rclone is a command line program to sync files and directories to
|
||
;; and from cloud storages. Tramp uses its mount utility to access
|
||
;; files and directories there. The configuration of rclone for
|
||
;; different storage systems is performed outside Tramp, see rclone(1).
|
||
|
||
;; A remote file under rclone control has the form
|
||
;; "/rclone:<remote>:/path/to/file". <remote> is the name of a
|
||
;; storage system in rclone's configuration. Therefore, such a remote
|
||
;; file name does not know of any user or port specification.
|
||
|
||
;;; Code:
|
||
|
||
(require 'tramp)
|
||
(require 'tramp-fuse)
|
||
|
||
;;;###tramp-autoload
|
||
(defconst tramp-rclone-method "rclone"
|
||
"When this method name is used, forward all calls to rclone mounts.")
|
||
|
||
(defcustom tramp-rclone-program "rclone"
|
||
"Name of the rclone program."
|
||
:group 'tramp
|
||
:version "27.1"
|
||
:type 'string
|
||
:link '(info-link :tag "Tramp manual" "(tramp) Setup of rclone method"))
|
||
|
||
;;;###tramp-autoload
|
||
(tramp--with-startup
|
||
(add-to-list 'tramp-methods
|
||
`(,tramp-rclone-method
|
||
;; Be careful changing "--dir-cache-time", this could
|
||
;; delay visibility of files. Since we use Tramp's
|
||
;; internal cache for file attributes, there shouldn't
|
||
;; be serious performance penalties when set to 0.
|
||
(tramp-mount-args
|
||
("--no-unicode-normalization" "--dir-cache-time" "0s"))
|
||
(tramp-copyto-args nil)
|
||
(tramp-moveto-args nil)
|
||
(tramp-about-args ("--full"))))
|
||
|
||
(add-to-list 'tramp-default-host-alist `(,tramp-rclone-method nil ""))
|
||
|
||
(tramp-set-completion-function
|
||
tramp-rclone-method '((tramp-rclone-parse-device-names ""))))
|
||
|
||
|
||
;; New handlers should be added here.
|
||
;;;###tramp-autoload
|
||
(defconst tramp-rclone-file-name-handler-alist
|
||
'(;; `abbreviate-file-name' performed by default handler.
|
||
(access-file . tramp-handle-access-file)
|
||
(add-name-to-file . tramp-handle-add-name-to-file)
|
||
;; `byte-compiler-base-file-name' performed by default handler.
|
||
(copy-directory . tramp-handle-copy-directory)
|
||
(copy-file . tramp-rclone-handle-copy-file)
|
||
(delete-directory . tramp-fuse-handle-delete-directory)
|
||
(delete-file . tramp-fuse-handle-delete-file)
|
||
;; `diff-latest-backup-file' performed by default handler.
|
||
(directory-file-name . tramp-handle-directory-file-name)
|
||
(directory-files . tramp-fuse-handle-directory-files)
|
||
(directory-files-and-attributes
|
||
. tramp-handle-directory-files-and-attributes)
|
||
(dired-compress-file . ignore)
|
||
(dired-uncache . tramp-handle-dired-uncache)
|
||
(exec-path . ignore)
|
||
(expand-file-name . tramp-handle-expand-file-name)
|
||
(file-accessible-directory-p . tramp-handle-file-accessible-directory-p)
|
||
(file-acl . ignore)
|
||
(file-attributes . tramp-fuse-handle-file-attributes)
|
||
(file-directory-p . tramp-handle-file-directory-p)
|
||
(file-equal-p . tramp-handle-file-equal-p)
|
||
(file-executable-p . tramp-fuse-handle-file-executable-p)
|
||
(file-exists-p . tramp-handle-file-exists-p)
|
||
(file-group-gid . tramp-handle-file-group-gid)
|
||
(file-in-directory-p . tramp-handle-file-in-directory-p)
|
||
(file-local-copy . tramp-handle-file-local-copy)
|
||
(file-locked-p . tramp-handle-file-locked-p)
|
||
(file-modes . tramp-handle-file-modes)
|
||
(file-name-all-completions . tramp-fuse-handle-file-name-all-completions)
|
||
(file-name-as-directory . tramp-handle-file-name-as-directory)
|
||
(file-name-case-insensitive-p . tramp-handle-file-name-case-insensitive-p)
|
||
(file-name-completion . tramp-handle-file-name-completion)
|
||
(file-name-directory . tramp-handle-file-name-directory)
|
||
(file-name-nondirectory . tramp-handle-file-name-nondirectory)
|
||
;; `file-name-sans-versions' performed by default handler.
|
||
(file-newer-than-file-p . tramp-handle-file-newer-than-file-p)
|
||
(file-notify-add-watch . tramp-handle-file-notify-add-watch)
|
||
(file-notify-rm-watch . tramp-handle-file-notify-rm-watch)
|
||
(file-notify-valid-p . tramp-handle-file-notify-valid-p)
|
||
(file-ownership-preserved-p . ignore)
|
||
(file-readable-p . tramp-rclone-handle-file-readable-p)
|
||
(file-regular-p . tramp-handle-file-regular-p)
|
||
(file-remote-p . tramp-handle-file-remote-p)
|
||
(file-selinux-context . tramp-handle-file-selinux-context)
|
||
(file-symlink-p . tramp-handle-file-symlink-p)
|
||
(file-system-info . tramp-rclone-handle-file-system-info)
|
||
(file-truename . tramp-handle-file-truename)
|
||
(file-user-uid . tramp-handle-file-user-uid)
|
||
(file-writable-p . tramp-handle-file-writable-p)
|
||
(find-backup-file-name . tramp-handle-find-backup-file-name)
|
||
;; `get-file-buffer' performed by default handler.
|
||
(insert-directory . tramp-handle-insert-directory)
|
||
(insert-file-contents . tramp-handle-insert-file-contents)
|
||
(list-system-processes . ignore)
|
||
(load . tramp-handle-load)
|
||
(lock-file . tramp-handle-lock-file)
|
||
(make-auto-save-file-name . tramp-handle-make-auto-save-file-name)
|
||
(make-directory . tramp-fuse-handle-make-directory)
|
||
(make-directory-internal . ignore)
|
||
(make-lock-file-name . tramp-handle-make-lock-file-name)
|
||
(make-nearby-temp-file . tramp-handle-make-nearby-temp-file)
|
||
(make-process . ignore)
|
||
(make-symbolic-link . tramp-handle-make-symbolic-link)
|
||
(memory-info . ignore)
|
||
(process-attributes . ignore)
|
||
(process-file . ignore)
|
||
(rename-file . tramp-rclone-handle-rename-file)
|
||
(set-file-acl . ignore)
|
||
(set-file-modes . ignore)
|
||
(set-file-selinux-context . ignore)
|
||
(set-file-times . ignore)
|
||
(set-visited-file-modtime . tramp-handle-set-visited-file-modtime)
|
||
(shell-command . ignore)
|
||
(start-file-process . ignore)
|
||
(substitute-in-file-name . tramp-handle-substitute-in-file-name)
|
||
(temporary-file-directory . tramp-handle-temporary-file-directory)
|
||
(tramp-get-home-directory . ignore)
|
||
(tramp-get-remote-gid . ignore)
|
||
(tramp-get-remote-groups . ignore)
|
||
(tramp-get-remote-uid . ignore)
|
||
(tramp-set-file-uid-gid . ignore)
|
||
(unhandled-file-name-directory . ignore)
|
||
(unlock-file . tramp-handle-unlock-file)
|
||
(vc-registered . ignore)
|
||
(verify-visited-file-modtime . tramp-handle-verify-visited-file-modtime)
|
||
(write-region . tramp-handle-write-region))
|
||
"Alist of handler functions for Tramp RCLONE method.
|
||
Operations not mentioned here will be handled by the default Emacs primitives.")
|
||
|
||
;; It must be a `defsubst' in order to push the whole code into
|
||
;; tramp-loaddefs.el. Otherwise, there would be recursive autoloading.
|
||
;;;###tramp-autoload
|
||
(defsubst tramp-rclone-file-name-p (vec-or-filename)
|
||
"Check if it's a VEC-OR-FILENAME for rclone."
|
||
(and-let* ((vec (tramp-ensure-dissected-file-name vec-or-filename))
|
||
((string= (tramp-file-name-method vec) tramp-rclone-method)))))
|
||
|
||
;;;###tramp-autoload
|
||
(defun tramp-rclone-file-name-handler (operation &rest args)
|
||
"Invoke the rclone handler for OPERATION and ARGS.
|
||
First arg specifies the OPERATION, second arg is a list of
|
||
arguments to pass to the OPERATION."
|
||
(if-let* ((fn (assoc operation tramp-rclone-file-name-handler-alist)))
|
||
(prog1 (save-match-data (apply (cdr fn) args))
|
||
(setq tramp-debug-message-fnh-function (cdr fn)))
|
||
(prog1 (tramp-run-real-handler operation args)
|
||
(setq tramp-debug-message-fnh-function operation))))
|
||
|
||
;;;###tramp-autoload
|
||
(tramp--with-startup
|
||
(tramp-register-foreign-file-name-handler
|
||
#'tramp-rclone-file-name-p #'tramp-rclone-file-name-handler))
|
||
|
||
;;;###tramp-autoload
|
||
(defun tramp-rclone-parse-device-names (_ignore)
|
||
"Return a list of (nil host) tuples allowed to access."
|
||
(with-tramp-connection-property nil "rclone-device-names"
|
||
(tramp-compat-seq-keep
|
||
(lambda (line)
|
||
(when (string-match (rx bol (group (+ (not blank))) ":" eol) line)
|
||
`(nil ,(match-string 1 line))))
|
||
(tramp-process-lines nil tramp-rclone-program "listremotes"))))
|
||
|
||
|
||
;; File name primitives.
|
||
|
||
(defun tramp-rclone-do-copy-or-rename-file
|
||
(op filename newname &optional ok-if-already-exists keep-date
|
||
preserve-uid-gid preserve-extended-attributes)
|
||
"Copy or rename a remote file.
|
||
OP must be `copy' or `rename' and indicates the operation to perform.
|
||
FILENAME specifies the file to copy or rename, NEWNAME is the name of
|
||
the new file (for copy) or the new name of the file (for rename).
|
||
OK-IF-ALREADY-EXISTS means don't barf if NEWNAME exists already.
|
||
KEEP-DATE means to make sure that NEWNAME has the same timestamp
|
||
as FILENAME. PRESERVE-UID-GID, when non-nil, instructs to keep
|
||
the uid and gid if both files are on the same host.
|
||
PRESERVE-EXTENDED-ATTRIBUTES is ignored.
|
||
|
||
This function is invoked by `tramp-rclone-handle-copy-file' and
|
||
`tramp-rclone-handle-rename-file'. It is an error if OP is neither
|
||
of `copy' and `rename'. FILENAME and NEWNAME must be absolute
|
||
file names."
|
||
;; FILENAME and NEWNAME are already expanded.
|
||
(unless (memq op '(copy rename))
|
||
(error "Unknown operation `%s', must be `copy' or `rename'" op))
|
||
|
||
(setq filename (file-truename filename))
|
||
(if (file-directory-p filename)
|
||
(progn
|
||
(copy-directory filename newname keep-date t)
|
||
(when (eq op 'rename) (delete-directory filename 'recursive)))
|
||
|
||
(let ((t1 (tramp-tramp-file-p filename))
|
||
(t2 (tramp-tramp-file-p newname))
|
||
(equal-remote (tramp-equal-remote filename newname))
|
||
(rclone-operation (if (eq op 'copy) "copyto" "moveto"))
|
||
(msg-operation (if (eq op 'copy) "Copying" "Renaming")))
|
||
|
||
(with-parsed-tramp-file-name (if t1 filename newname) nil
|
||
(tramp-barf-if-file-missing v filename
|
||
(when (and (not ok-if-already-exists) (file-exists-p newname))
|
||
(tramp-error v 'file-already-exists newname))
|
||
(when (and (file-directory-p newname)
|
||
(not (directory-name-p newname)))
|
||
(tramp-error v 'file-error "File is a directory %s" newname))
|
||
(when (file-regular-p newname)
|
||
(delete-file newname))
|
||
|
||
(if (or (and equal-remote
|
||
(tramp-get-connection-property v "direct-copy-failed"))
|
||
(and t1 (not (tramp-rclone-file-name-p filename)))
|
||
(and t2 (not (tramp-rclone-file-name-p newname))))
|
||
|
||
;; We cannot copy or rename directly.
|
||
(let ((tmpfile (tramp-compat-make-temp-file filename)))
|
||
(if (eq op 'copy)
|
||
(copy-file
|
||
filename tmpfile t keep-date preserve-uid-gid
|
||
preserve-extended-attributes)
|
||
(rename-file filename tmpfile t))
|
||
(rename-file tmpfile newname ok-if-already-exists))
|
||
|
||
;; Direct action.
|
||
(with-tramp-progress-reporter
|
||
v 0 (format "%s %s to %s" msg-operation filename newname)
|
||
(unless (zerop
|
||
(tramp-rclone-send-command
|
||
v rclone-operation
|
||
(tramp-rclone-remote-file-name filename)
|
||
(tramp-rclone-remote-file-name newname)))
|
||
(if (or (not equal-remote)
|
||
(and equal-remote
|
||
(tramp-get-connection-property
|
||
v "direct-copy-failed")))
|
||
(tramp-error
|
||
v 'file-error
|
||
"Error %s `%s' `%s'" msg-operation filename newname)
|
||
|
||
;; Some WebDAV server, like the one from QNAP, do
|
||
;; not support direct copy/move. Try a fallback.
|
||
(tramp-set-connection-property v "direct-copy-failed" t)
|
||
(tramp-rclone-do-copy-or-rename-file
|
||
op filename newname ok-if-already-exists keep-date
|
||
preserve-uid-gid preserve-extended-attributes))))
|
||
|
||
(when (and t1 (eq op 'rename))
|
||
(while (file-exists-p filename)
|
||
(with-parsed-tramp-file-name filename v1
|
||
(tramp-flush-file-properties v1 v1-localname))))
|
||
|
||
(when t2
|
||
(with-parsed-tramp-file-name newname v2
|
||
(tramp-flush-file-properties v2 v2-localname)))))))))
|
||
|
||
(defun tramp-rclone-handle-copy-file
|
||
(filename newname &optional ok-if-already-exists keep-date
|
||
preserve-uid-gid preserve-extended-attributes)
|
||
"Like `copy-file' for Tramp files."
|
||
(setq filename (expand-file-name filename)
|
||
newname (expand-file-name newname))
|
||
;; At least one file a Tramp file?
|
||
(if (or (tramp-tramp-file-p filename)
|
||
(tramp-tramp-file-p newname))
|
||
(tramp-rclone-do-copy-or-rename-file
|
||
'copy filename newname ok-if-already-exists keep-date
|
||
preserve-uid-gid preserve-extended-attributes)
|
||
(tramp-run-real-handler
|
||
#'copy-file
|
||
(list filename newname ok-if-already-exists keep-date
|
||
preserve-uid-gid preserve-extended-attributes))))
|
||
|
||
(defun tramp-rclone-handle-file-readable-p (filename)
|
||
"Like `file-readable-p' for Tramp files."
|
||
(with-parsed-tramp-file-name (expand-file-name filename) nil
|
||
(with-tramp-file-property v localname "file-readable-p"
|
||
(file-readable-p (tramp-fuse-local-file-name filename)))))
|
||
|
||
(defun tramp-rclone-handle-file-system-info (filename)
|
||
"Like `file-system-info' for Tramp files."
|
||
(ignore-errors
|
||
(unless (file-directory-p filename)
|
||
(setq filename (file-name-directory filename)))
|
||
(with-parsed-tramp-file-name (expand-file-name filename) nil
|
||
(tramp-message v 5 "file system info: %s" localname)
|
||
(when (zerop (tramp-rclone-send-command v "about" (concat host ":")))
|
||
(with-current-buffer (tramp-get-connection-buffer v)
|
||
(let (total used free)
|
||
(goto-char (point-min))
|
||
(while (not (eobp))
|
||
(when (looking-at (rx "Total: " (+ blank) (group (+ digit))))
|
||
(setq total (string-to-number (match-string 1))))
|
||
(when (looking-at (rx "Used: " (+ blank) (group (+ digit))))
|
||
(setq used (string-to-number (match-string 1))))
|
||
(when (looking-at (rx "Free: " (+ blank) (group (+ digit))))
|
||
(setq free (string-to-number (match-string 1))))
|
||
(forward-line))
|
||
(when used
|
||
;; The used number of bytes is not part of the result.
|
||
;; As side effect, we store it as file property.
|
||
(tramp-set-file-property v localname "used-bytes" used))
|
||
;; Result.
|
||
(when (and total free)
|
||
(list total free (- total free)))))))))
|
||
|
||
(defun tramp-rclone-handle-rename-file
|
||
(filename newname &optional ok-if-already-exists)
|
||
"Like `rename-file' for Tramp files."
|
||
(setq filename (expand-file-name filename)
|
||
newname (expand-file-name newname))
|
||
;; At least one file a Tramp file?
|
||
(if (or (tramp-tramp-file-p filename)
|
||
(tramp-tramp-file-p newname))
|
||
(tramp-rclone-do-copy-or-rename-file
|
||
'rename filename newname ok-if-already-exists
|
||
'keep-date 'preserve-uid-gid)
|
||
(tramp-run-real-handler
|
||
#'rename-file (list filename newname ok-if-already-exists))))
|
||
|
||
|
||
;; File name conversions.
|
||
|
||
(defun tramp-rclone-remote-file-name (filename)
|
||
"Return FILENAME as used in the `rclone' command."
|
||
(setq filename (file-name-unquote (expand-file-name filename)))
|
||
(if (tramp-rclone-file-name-p filename)
|
||
(with-parsed-tramp-file-name filename nil
|
||
;; As long as we call `tramp-rclone-maybe-open-connection' here,
|
||
;; we cache the result.
|
||
(with-tramp-file-property v localname "remote-file-name"
|
||
(tramp-rclone-maybe-open-connection v)
|
||
;; TODO: This shall be handled by `expand-file-name'.
|
||
(setq localname
|
||
(replace-regexp-in-string (rx bol ".") "" (or localname "")))
|
||
(format "%s%s" (tramp-fuse-mounted-p v) localname)))
|
||
;; It is a local file name.
|
||
filename))
|
||
|
||
(defun tramp-rclone-maybe-open-connection (vec)
|
||
"Maybe open a connection VEC.
|
||
Does not do anything if a connection is already open, but re-opens the
|
||
connection if a previous connection has died for some reason."
|
||
;; During completion, don't reopen a new connection.
|
||
(unless (tramp-connectable-p vec)
|
||
(throw 'non-essential 'non-essential))
|
||
|
||
(with-tramp-debug-message vec "Opening connection"
|
||
(let ((host (tramp-file-name-host vec)))
|
||
(when (rassoc `(,host) (tramp-rclone-parse-device-names nil))
|
||
(if (tramp-string-empty-or-nil-p host)
|
||
(tramp-error vec 'file-error "Storage %s not connected" host))
|
||
;; We need a process bound to the connection buffer.
|
||
;; Therefore, we create a dummy process. Maybe there is a
|
||
;; better solution?
|
||
(unless (get-buffer-process (tramp-get-connection-buffer vec))
|
||
(let ((p (make-network-process
|
||
:name (tramp-get-connection-name vec)
|
||
:buffer (tramp-get-connection-buffer vec)
|
||
:server t :host 'local :service t :noquery t)))
|
||
(tramp-post-process-creation p vec)
|
||
|
||
;; Set connection-local variables.
|
||
(tramp-set-connection-local-variables vec)))
|
||
|
||
;; Create directory.
|
||
(unless (file-directory-p (tramp-fuse-mount-point vec))
|
||
(make-directory (tramp-fuse-mount-point vec) 'parents))
|
||
|
||
;; Mount. This command does not return, so we use 0 as
|
||
;; DESTINATION of `tramp-call-process'.
|
||
(unless (tramp-fuse-mounted-p vec)
|
||
(apply
|
||
#'tramp-call-process
|
||
vec tramp-rclone-program nil 0 nil
|
||
"mount" (tramp-fuse-mount-spec vec)
|
||
(tramp-fuse-mount-point vec)
|
||
(tramp-get-method-parameter vec 'tramp-mount-args))
|
||
(while (not (file-exists-p (tramp-make-tramp-file-name vec 'noloc)))
|
||
(tramp-cleanup-connection vec 'keep-debug 'keep-password))
|
||
|
||
;; Mark it as connected.
|
||
(add-to-list 'tramp-fuse-mount-points (tramp-file-name-unify vec))
|
||
(tramp-set-connection-property
|
||
(tramp-get-connection-process vec) "connected" t))))
|
||
|
||
;; In `tramp-check-cached-permissions', the connection properties
|
||
;; "{uid,gid}-{integer,string}" are used. We set them to proper values.
|
||
(with-tramp-connection-property
|
||
vec "uid-integer" (tramp-get-local-uid 'integer))
|
||
(with-tramp-connection-property
|
||
vec "gid-integer" (tramp-get-local-gid 'integer))
|
||
(with-tramp-connection-property
|
||
vec "uid-string" (tramp-get-local-uid 'string))
|
||
(with-tramp-connection-property
|
||
vec "gid-string" (tramp-get-local-gid 'string))))
|
||
|
||
(defun tramp-rclone-send-command (vec &rest args)
|
||
"Send a command to connection VEC.
|
||
The command is the list of strings ARGS."
|
||
(with-current-buffer (tramp-get-connection-buffer vec)
|
||
(erase-buffer)
|
||
(let ((flags (tramp-get-method-parameter
|
||
vec (intern (format "tramp-%s-args" (car args))))))
|
||
(apply #'tramp-call-process
|
||
vec tramp-rclone-program nil t nil (append args flags)))))
|
||
|
||
(add-hook 'tramp-unload-hook
|
||
(lambda ()
|
||
(unload-feature 'tramp-rclone 'force)))
|
||
|
||
(provide 'tramp-rclone)
|
||
|
||
;;; tramp-rclone.el ends here
|