[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Emacs-diffs] master a7d9c38 3/4: Add Tramp rclone method
|
From: |
Michael Albinus |
|
Subject: |
[Emacs-diffs] master a7d9c38 3/4: Add Tramp rclone method |
|
Date: |
Sat, 24 Nov 2018 08:02:14 -0500 (EST) |
branch: master
commit a7d9c38da52f413410e17a65d1e90b89edb6cbc4
Author: Michael Albinus <address@hidden>
Commit: Michael Albinus <address@hidden>
Add Tramp rclone method
* doc/misc/tramp.texi (Top): Remove "History".
(History): Remove node.
(Quick Start Guide): New section "Using rclone".
(External methods) <rclone>: Describe.
* etc/NEWS: Mention Tramp rclone method.
* lisp/net/tramp-rclone.el: New file.
---
doc/misc/tramp.texi | 81 ++++---
etc/NEWS | 4 +
lisp/net/tramp-rclone.el | 558 +++++++++++++++++++++++++++++++++++++++++++++++
3 files changed, 616 insertions(+), 27 deletions(-)
diff --git a/doc/misc/tramp.texi b/doc/misc/tramp.texi
index 5a375b1..d5a45ad 100644
--- a/doc/misc/tramp.texi
+++ b/doc/misc/tramp.texi
@@ -86,7 +86,6 @@ Archive}.
For the end user:
* Obtaining @value{tramp}:: How to obtain @value{tramp}.
-* History:: History of @value{tramp}.
@ifset installchapter
* Installation:: Installing @value{tramp} with your Emacs.
@end ifset
@@ -379,32 +378,6 @@ $ autoconf
@end example
address@hidden History
address@hidden History of @value{tramp}
address@hidden history
address@hidden development history
-
address@hidden development started at the end of November 1998 as
address@hidden It provided only one method of access. It used
address@hidden for login and @command{scp} to transfer file contents.
-The name was changed to @file{rcp.el} before it got its present name
address@hidden New methods of remote access were added, so was support
-for version control.
-
-April 2000 was the first time when multi-hop methods were added. In
-July 2002, @value{tramp} unified file names with Ange address@hidden In July
-2004, proxy hosts replaced multi-hop methods. Running commands on
-remote hosts was introduced in December 2005. Support for gateways
-since April 2007 (and removed in December 2016). GVFS integration
-started in February 2009. Remote commands on MS Windows hosts since
-September 2011. Ad-hoc multi-hop methods (with a changed syntax)
-re-enabled in November 2011. In November 2012, added Juergen
-Hoetzel's @file{tramp-adb.el}. Archive file names are supported since
-December 2017.
-
-XEmacs support was stopped in January 2016. Since March 2017,
address@hidden syntax mandates a method.
-
@c Installation chapter is necessary only in case of standalone
@c installation. Text taken from trampinst.texi.
@ifset installchapter
@@ -562,6 +535,18 @@ be accessed via the @command{adb} command. No user or
host name is
needed. The file name syntax is @address@hidden,,/path/to/file}}.
address@hidden Start Guide: @option{rclone} method}
address@hidden Using @command{rclone}
address@hidden method @option{rclone}
address@hidden @option{rclone} method
+
+A convenient way to access system storages is the @command{rclone}
+program. If you have configured a storage in @command{rclone} under a
+name @samp{storage} (for example), you could access it via the remote
+file name syntax @address@hidden,storage,/path/to/file}}. User
+names are not needed.
+
+
@node Configuration
@chapter Configuring @value{tramp}
@cindex configuration
@@ -1054,6 +1039,48 @@ specified using @file{device#42} host name syntax or
@value{tramp} can
use the default value as declared in @command{adb} command. Port
numbers are not applicable to Android devices connected through address@hidden
+
address@hidden @option{rclone}
address@hidden method @option{rclone}
address@hidden @option{rclone} method
+
address@hidden tramp-rclone-program
+The program @command{rclone} allows to access different system
+storages in the cloud, see @url{https://rclone.org/} for a list of
+supported systems. If the @command{rclone} program isn't found in
+your @env{PATH} environment variable, you can tell Tramp its absolute
+path via the user option @code{tramp-rclone-program}.
+
+A system storage must be configured via the @command{rclone config}
+command, outside Emacs. If you have configured a storage in
address@hidden under a name @samp{storage} (for example), you could
+access it via the remote file name
+
address@hidden
address@hidden,storage,/path/to/file}
address@hidden example
+
+User names are part of the @command{rclone} configuration, and not
+needed in the remote file name. If a user name is contained in the
+remote file name, it is ignored.
+
+Internally, Tramp mounts the remote system storage at location
address@hidden/tmp/tramp.rclone.storage}, with @file{storage} being the name
+of the configured system storage.
+
+Optional flags to the different @option{rclone} operations could be
+passed as connection property, @xref{Predefined connection
+information}. Supported properties are @samp{mount-args},
address@hidden and @samp{moveto-args}.
+
+Access via @option{rclone} is slow. If you have an alternative method
+for accessing the system storage, you shall prefer this. @ref{GVFS
+based methods} for example, methods @option{gdrive} and
address@hidden
+
address@hidden: The @option{rclone} method is experimental, don't use
+it in production systems!
+
@end table
diff --git a/etc/NEWS b/etc/NEWS
index f413bbe..7036c78 100644
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -823,6 +823,10 @@ process. It now accepts signals specified either by name
or by its number.
or NextCloud hosted files and directories.
+++
+*** New connection method "rclone", which allows to access system
+storages via the 'rclone' program. This feature is experimental.
+
++++
*** Connection methods "obex" and "synce" are removed, because they
are obsoleted in GVFS.
diff --git a/lisp/net/tramp-rclone.el b/lisp/net/tramp-rclone.el
new file mode 100644
index 0000000..725a6f1
--- /dev/null
+++ b/lisp/net/tramp-rclone.el
@@ -0,0 +1,558 @@
+;;; tramp-rclone.el --- Tramp access functions to cloud storages -*-
lexical-binding:t -*-
+
+;; Copyright (C) 2018 Free Software Foundation, Inc.
+
+;; Author: Michael Albinus <address@hidden>
+;; 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 any user or port specification.
+
+;;; Code:
+
+(eval-when-compile (require 'cl-lib))
+(require 'tramp)
+
+;; TODDDDDDDDDO: REPLACE
+(require 'tramp-gvfs)
+
+;;;###tramp-autoload
+(defconst tramp-rclone-method "rclone"
+ "When this method name is used, forward all calls to rclone mounts.")
+
+;;;###tramp-autoload
+(defcustom tramp-rclone-program "rclone"
+ "Name of the rclone program."
+ :group 'tramp
+ :version "27.1"
+ :type 'string)
+
+;;;###tramp-autoload
+(add-to-list
+ 'tramp-methods
+ `(,tramp-rclone-method
+ (tramp-mount-args nil)
+ (tramp-copyto-args nil)
+ (tramp-moveto-args nil)
+ (tramp-about-args ("--full"))))
+
+;;;###tramp-autoload
+(eval-after-load 'tramp
+ '(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
+ '((access-file . ignore)
+ (add-name-to-file . tramp-handle-add-name-to-file)
+ ;; `byte-compiler-base-file-name' performed by default handler.
+ ;; `copy-directory' performed by default handler.
+ (copy-file . tramp-rclone-handle-copy-file)
+ (delete-directory . tramp-rclone-handle-delete-directory)
+ (delete-file . tramp-rclone-handle-delete-file)
+ ;; `diff-latest-backup-file' performed by default handler.
+ (directory-file-name . tramp-handle-directory-file-name)
+ (directory-files . tramp-rclone-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' performed by default handler.
+ (file-accessible-directory-p . tramp-handle-file-accessible-directory-p)
+ (file-acl . ignore)
+ (file-attributes . tramp-rclone-handle-file-attributes)
+ (file-directory-p . tramp-handle-file-directory-p)
+ (file-equal-p . tramp-handle-file-equal-p)
+ (file-executable-p . tramp-rclone-handle-file-executable-p)
+ (file-exists-p . tramp-handle-file-exists-p)
+ (file-in-directory-p . tramp-handle-file-in-directory-p)
+ (file-local-copy . tramp-gvfs-handle-file-local-copy)
+ (file-modes . tramp-handle-file-modes)
+ (file-name-all-completions . tramp-rclone-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 . ignore)
+ (file-notify-rm-watch . ignore)
+ (file-notify-valid-p . ignore)
+ (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-writable-p . tramp-gvfs-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)
+ (load . tramp-handle-load)
+ (make-auto-save-file-name . tramp-handle-make-auto-save-file-name)
+ (make-directory . tramp-rclone-handle-make-directory)
+ (make-directory-internal . ignore)
+ (make-nearby-temp-file . tramp-handle-make-nearby-temp-file)
+ (make-symbolic-link . tramp-handle-make-symbolic-link)
+ (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)
+ (unhandled-file-name-directory . ignore)
+ (vc-registered . ignore)
+ (verify-visited-file-modtime . tramp-handle-verify-visited-file-modtime)
+ (write-region . tramp-gvfs-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 (filename)
+ "Check if it's a filename for rclone."
+ (and (tramp-tramp-file-p filename)
+ (string= (tramp-file-name-method (tramp-dissect-file-name filename))
+ tramp-rclone-method)))
+
+;;;###tramp-autoload
+(defun tramp-rclone-file-name-handler (operation &rest args)
+ "Invoke the rclone handler for OPERATION.
+First arg specifies the OPERATION, second arg is a list of arguments to
+pass to the OPERATION."
+ (let ((fn (assoc operation tramp-rclone-file-name-handler-alist)))
+ (if fn
+ (save-match-data (apply (cdr fn) args))
+ (tramp-run-real-handler operation args))))
+
+;;;###tramp-autoload
+(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-timeout (10)
+ (with-temp-buffer
+ ;; `call-process' does not react on timer under MS Windows.
+ ;; That's why we use `start-process'.
+ (let ((p (start-process
+ tramp-rclone-program (current-buffer)
+ tramp-rclone-program "listremotes"))
+ (v (make-tramp-file-name :method tramp-rclone-method))
+ result)
+ (tramp-message v 6 "%s" (mapconcat 'identity (process-command p) " "))
+ (process-put p 'adjust-window-size-function 'ignore)
+ (set-process-query-on-exit-flag p nil)
+ (while (process-live-p p)
+ (accept-process-output p 0.1))
+ (accept-process-output p 0.1)
+ (tramp-message v 6 "\n%s" (buffer-string))
+ (goto-char (point-min))
+ (while (search-forward-regexp "^\\(\\S-+\\):$" nil t)
+ (push (list nil (match-string 1)) result))
+ result))))
+
+
+;; 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."
+ (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))
+ (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
+ (when (and (not ok-if-already-exists) (file-exists-p newname))
+ (tramp-error v 'file-already-exists newname))
+
+ (if (or (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)))
+ (tramp-error
+ v 'file-error
+ "Error %s `%s' `%s'" msg-operation filename newname)))
+
+ (when (and t1 (eq op 'rename))
+ (with-parsed-tramp-file-name filename v1
+ (tramp-flush-file-properties
+ v1 (file-name-directory v1-localname))
+ (tramp-flush-file-properties v1 v1-localname)))
+
+ (when t2
+ (with-parsed-tramp-file-name newname v2
+ (tramp-flush-file-properties
+ v2 (file-name-directory v2-localname))
+ (tramp-flush-file-properties v2 v2-localname)
+ (when (tramp-rclone-file-name-p newname)
+ (tramp-rclone-flush-mount v2)))))))))
+
+(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))
+ (setq 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-delete-directory
+ (directory &optional recursive trash)
+ "Like `delete-directory' for Tramp files."
+ (with-parsed-tramp-file-name (expand-file-name directory) nil
+ (tramp-flush-file-properties v (file-name-directory localname))
+ (tramp-flush-directory-properties v localname)
+ (delete-directory
+ (tramp-rclone-local-file-name directory) recursive trash)))
+
+(defun tramp-rclone-handle-delete-file (filename &optional trash)
+ "Like `delete-file' for Tramp files."
+ (with-parsed-tramp-file-name (expand-file-name filename) nil
+ (tramp-flush-file-properties v (file-name-directory localname))
+ (tramp-flush-file-properties v localname)
+ (delete-file (tramp-rclone-local-file-name filename) trash)))
+
+(defun tramp-rclone-handle-directory-files
+ (directory &optional full match nosort)
+ "Like `directory-files' for Tramp files."
+ (when (file-directory-p directory)
+ (setq directory (file-name-as-directory (expand-file-name directory)))
+ (with-parsed-tramp-file-name directory nil
+ (let ((result
+ (directory-files
+ (tramp-rclone-local-file-name directory) full match)))
+ ;; Massage the result.
+ (when full
+ (let* ((quoted (file-name-quoted-p directory))
+ (local
+ (concat "^" (regexp-quote (tramp-rclone-mount-point v))))
+ (remote
+ (funcall (if quoted 'file-name-quote 'identity)
+ (file-remote-p directory))))
+ (setq result
+ (mapcar
+ (lambda (x) (replace-regexp-in-string local remote x))
+ result))))
+ ;; Some storage systems do not return "." and "..".
+ (dolist (item '(".." "."))
+ (when (and (string-match-p (or match (regexp-quote item)) item)
+ (not
+ (member (if full (setq item (concat directory item)) item)
+ result)))
+ (setq result (cons item result))))
+ ;; Return result.
+ (if nosort result (sort result 'string<))))))
+
+(defun tramp-rclone-handle-file-attributes (filename &optional id-format)
+ "Like `file-attributes' for Tramp files."
+ (with-parsed-tramp-file-name (expand-file-name filename) nil
+ (with-tramp-file-property
+ v localname (format "file-attributes-%s" id-format)
+ (file-attributes (tramp-rclone-local-file-name filename) id-format))))
+
+(defun tramp-rclone-handle-file-executable-p (filename)
+ "Like `file-executable-p' for Tramp files."
+ (file-executable-p (tramp-rclone-local-file-name filename)))
+
+(defun tramp-rclone-handle-file-name-all-completions (filename directory)
+ "Like `file-name-all-completions' for Tramp files."
+ (file-name-all-completions filename (tramp-rclone-local-file-name
directory)))
+
+(defun tramp-rclone-handle-file-readable-p (filename)
+ "Like `file-readable-p' for Tramp files."
+ (file-readable-p (tramp-rclone-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)
+ (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 "Total: [[:space:]]+\\([[:digit:]]+\\)")
+ (setq total (string-to-number (match-string 1))))
+ (when (looking-at "Used: [[:space:]]+\\([[:digit:]]+\\)")
+ (setq used (string-to-number (match-string 1))))
+ (when (looking-at "Free: [[:space:]]+\\([[: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-insert-directory
+ (filename switches &optional wildcard full-directory-p)
+ "Like `insert-directory' for Tramp files."
+ (insert-directory
+ (tramp-rclone-local-file-name filename) switches wildcard full-directory-p)
+ (goto-char (point-min))
+ (while (search-forward (tramp-rclone-local-file-name filename) nil 'noerror)
+ (replace-match filename)))
+
+(defun tramp-rclone-handle-insert-file-contents
+ (filename &optional visit beg end replace)
+ "Like `insert-file-contents' for Tramp files."
+ (let ((result
+ (insert-file-contents
+ (tramp-rclone-local-file-name filename) visit beg end replace)))
+ (prog1
+ (list (expand-file-name filename)
+ (cadr result))
+ (when visit (setq buffer-file-name filename)))))
+
+(defun tramp-rclone-handle-make-directory (dir &optional parents)
+ "Like `make-directory' for Tramp files."
+ (with-parsed-tramp-file-name (expand-file-name dir) nil
+ ;; When PARENTS is non-nil, DIR could be a chain of non-existent
+ ;; directories a/b/c/... Instead of checking, we simply flush the
+ ;; whole cache.
+ (tramp-flush-file-properties v localname)
+ (tramp-flush-directory-properties
+ v (if parents "/" (file-name-directory localname)))
+ (make-directory (tramp-rclone-local-file-name dir) parents)))
+
+(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))
+ (setq 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-mount-point (vec)
+ "Return local mount point of VEC."
+ (expand-file-name
+ (concat
+ tramp-temp-name-prefix (tramp-file-name-method vec)
+ "." (tramp-file-name-host vec))
+ (tramp-compat-temporary-file-directory)))
+
+(defun tramp-rclone-mounted-p (vec)
+ "Check, whether storage system determined by VEC is mounted."
+ (or
+ ;; We set this property at the end of
+ ;; `tramp-rclone-maybe-open-connection'. Let's use it as
+ ;; indicator.
+ (tramp-get-connection-property vec "uid-integer" nil)
+ ;; If it is mounted, "." is not shown. If the endpoint is not
+ ;; connected, `directory-files' returns an error.
+ (ignore-errors
+ (not (member "." (directory-files (tramp-rclone-mount-point vec)))))))
+
+(defun tramp-rclone-flush-mount (vec)
+ "Flush directory cache of VEC mount."
+ (let ((rclone-pid
+ ;; Identify rclone process.
+ (with-tramp-file-property vec "/" "rclone-pid"
+ (catch 'pid
+ (dolist (pid (list-system-processes)) ;; "pidof rclone" ?
+ (and (string-match
+ (regexp-quote
+ (format "rclone mount %s:" (tramp-file-name-host vec)))
+ (or (cdr (assoc 'args (process-attributes pid))) ""))
+ (throw 'pid pid)))))))
+ ;; Send a SIGHUP in order to flush directory caches.
+ (when rclone-pid
+ (tramp-message
+ vec 6 "Send SIGHUP %d: %s"
+ rclone-pid (cdr (assoc 'args (process-attributes rclone-pid))))
+ (signal-process rclone-pid 'SIGHUP))))
+
+(defun tramp-rclone-local-file-name (filename)
+ "Return local mount name of FILENAME."
+ (with-parsed-tramp-file-name (expand-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 "local-file-name"
+ (tramp-rclone-maybe-open-connection v)
+ (let ((quoted (file-name-quoted-p localname))
+ (localname (file-name-unquote localname)))
+ (funcall
+ (if quoted 'file-name-quote 'identity)
+ (expand-file-name
+ (if (file-name-absolute-p localname)
+ (substring localname 1) localname)
+ (tramp-rclone-mount-point v)))))))
+
+(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
+ ;; TODO: This shall be handled by `expand-file-name'.
+ (setq localname (replace-regexp-in-string "^\\." "" (or localname "")))
+ (format "%s:%s" host localname))
+ 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."
+ (unless (or (null non-essential) (tramp-rclone-mounted-p vec))
+ (let ((host (tramp-file-name-host vec)))
+ (if (zerop (length host))
+ (tramp-error vec 'file-error "Storage %s not connected" host))
+ (with-tramp-progress-reporter vec 3 "Mounting rclone storage"
+ (unless (file-directory-p (tramp-rclone-mount-point vec))
+ (make-directory (tramp-rclone-mount-point vec) 'parents))
+ (let* ((buf (tramp-get-connection-buffer vec))
+ (coding-system-for-read 'utf-8-dos) ;is this correct?
+ (process-connection-type tramp-process-connection-type)
+ (args `("mount" ,(concat host ":")
+ ,(tramp-rclone-mount-point vec)
+ ,(tramp-get-method-parameter vec 'tramp-mount-args)))
+ (p (let ((default-directory
+ (tramp-compat-temporary-file-directory)))
+ (apply 'start-process (tramp-get-connection-name vec) buf
+ tramp-rclone-program (delq nil args)))))
+ (tramp-message
+ vec 6 "%s" (mapconcat 'identity (process-command p) " "))
+ (process-put p 'adjust-window-size-function 'ignore)
+ (set-process-query-on-exit-flag p nil)
+
+ ;; Set connection-local variables.
+ (tramp-set-connection-local-variables vec)))))
+
+ ;; In `tramp-check-cached-permissions', the connection properties
+ ;; {uig,gid}-{integer,string} are used. We set them to proper values.
+ (unless (tramp-get-connection-property vec "uid-integer" nil)
+ (tramp-set-connection-property
+ vec "uid-integer" (tramp-get-local-uid 'integer))
+ (tramp-set-connection-property
+ vec "gid-integer" (tramp-get-local-gid 'integer))
+ (tramp-set-connection-property
+ vec "uid-string" (tramp-get-local-uid 'string))
+ (tramp-set-connection-property
+ vec "gid-string" (tramp-get-local-gid 'string))))
+
+(defun tramp-rclone-send-command (vec &rest args)
+ "Send the COMMAND to connection VEC."
+; (tramp-rclone-maybe-open-connection vec)
+ (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)
+
+;;; TODO:
+
+;; * Refactor tramp-gvfs.el in order to move used functions to
+;; tramp.el.
+;;
+;; * If possible, get rid of rclone mount. Maybe it is more
+;; performant then.
+
+;;; tramp-rclone.el ends here