Add SyncRepo.storeFile.

This is to support storing a file into a directory path in the repo.

Only implemented for ContentRepo and DirectoryRepo for now.

Author: xiaoruoruo

app/src/main/java/com/orgzly/android/data/DataRepository.kt

@@ -1555,7 +1555,6 @@ class DataRepository @Inject constructor(
         val fileName = documentFile.name
 
         val attachDir = notePayload.attachDir(context)
-        val filePath = attachDir + File.separator + fileName
 
         val book = getBookView(bookId)
                 ?: throw IOException(resources.getString(R.string.book_does_not_exist_anymore))
@@ -1572,7 +1571,7 @@ class DataRepository @Inject constructor(
             LogUtils.d(TAG, "Wrote to file $tempFile")
         }
 
-        repo.storeBook(tempFile, filePath)
+        repo.storeFile(tempFile, attachDir, fileName)
         LogUtils.d(TAG, "Stored file to repo")
         tempFile.delete()
     }

app/src/main/java/com/orgzly/android/repos/ContentRepo.java

@@ -128,18 +128,25 @@ public VersionedRook retrieveBook(String fileName, File destinationFile) throws
 
     @Override
     public VersionedRook storeBook(File file, String fileName) throws IOException {
+        return storeFile(file, "", fileName);
+    }
+
+    @Override
+    public VersionedRook storeFile(File file, String pathInRepo, String fileName) throws IOException {
         if (!file.exists()) {
             throw new FileNotFoundException("File " + file + " does not exist");
         }
 
+        DocumentFile documentFile = createRecursive(repoDocumentFile, pathInRepo);
+
         /* Delete existing file. */
-        DocumentFile existingFile = repoDocumentFile.findFile(fileName);
+        DocumentFile existingFile = documentFile.findFile(fileName);
         if (existingFile != null) {
             existingFile.delete();
         }
 
         /* Create new file. */
-        DocumentFile destinationFile = repoDocumentFile.createFile("text/*", fileName);
+        DocumentFile destinationFile = documentFile.createFile("text/*", fileName);
 
         if (destinationFile == null) {
             throw new IOException("Failed creating " + fileName + " in " + repoUri);
@@ -163,6 +170,27 @@ public VersionedRook storeBook(File file, String fileName) throws IOException {
         return new VersionedRook(repoId, RepoType.DOCUMENT, getUri(), uri, rev, mtime);
     }
 
+    private DocumentFile createRecursive(DocumentFile parent, String path) {
+        if (".".equals(path) || "".equals(path)) {
+            return parent;
+        }
+        int l = path.lastIndexOf('/');
+        DocumentFile p;
+        if (l >= 0) {
+            p = createRecursive(parent, path.substring(0, l));
+        } else {
+            p = parent;
+        }
+        String subdir = path.substring(l+1);
+        DocumentFile f = p.findFile(subdir);
+        if (f != null) {
+            // already exist, return it
+            return f;
+        }
+        // Otherwise, create the directory
+        return p.createDirectory(subdir);
+    }
+
     @Override
     public VersionedRook renameBook(Uri from, String name) throws IOException {
         DocumentFile fromDocFile = DocumentFile.fromSingleUri(context, from);

app/src/main/java/com/orgzly/android/repos/DatabaseRepo.java

@@ -66,6 +66,11 @@ public VersionedRook storeBook(File file, String fileName) throws IOException {
         return dbRepo.createBook(repoId, vrook, content);
     }
 
+    @Override
+    public VersionedRook storeFile(File file, String pathInRepo, String fileName) throws IOException {
+        throw new UnsupportedOperationException();
+    }
+
     @Override
     public VersionedRook renameBook(Uri fromUri, String name) {
         Uri toUri = UriUtils.getUriForNewName(fromUri, name);

app/src/main/java/com/orgzly/android/repos/DirectoryRepo.java

@@ -158,6 +158,11 @@ public VersionedRook storeBook(File file, String fileName) throws IOException {
         return new VersionedRook(repoId, RepoType.DIRECTORY, repoUri, uri, rev, mtime);
     }
 
+    @Override
+    public VersionedRook storeFile(File file, String pathInRepo, String fileName) throws IOException {
+        return storeBook(file, pathInRepo + File.separator + fileName);
+    }
+
     @Override
     public VersionedRook renameBook(Uri fromUri, String name) throws IOException {
         String fromFilePath = fromUri.getPath();

app/src/main/java/com/orgzly/android/repos/DropboxRepo.java

@@ -51,6 +51,11 @@ public VersionedRook storeBook(File file, String fileName) throws IOException {
         return client.upload(file, repoUri, fileName);
     }
 
+    @Override
+    public VersionedRook storeFile(File file, String pathInRepo, String fileName) throws IOException {
+        throw new UnsupportedOperationException();
+    }
+
     @Override
     public VersionedRook renameBook(Uri fromUri, String name) throws IOException {
         Uri toUri = UriUtils.getUriForNewName(fromUri, name);

app/src/main/java/com/orgzly/android/repos/GitRepo.java

@@ -193,6 +193,11 @@ public VersionedRook storeBook(File file, String fileName) throws IOException {
         return currentVersionedRook(Uri.EMPTY.buildUpon().appendPath(fileName).build());
     }
 
+    @Override
+    public VersionedRook storeFile(File file, String pathInRepo, String fileName) throws IOException {
+        throw new UnsupportedOperationException();
+    }
+
     private RevWalk walk() {
         return new RevWalk(git.getRepository());
     }

app/src/main/java/com/orgzly/android/repos/MockRepo.java

@@ -62,6 +62,12 @@ public VersionedRook storeBook(File file, String fileName) throws IOException {
         return databaseRepo.storeBook(file, fileName);
     }
 
+    @Override
+    public VersionedRook storeFile(File file, String pathInRepo, String fileName) throws IOException {
+        SystemClock.sleep(SLEEP_FOR_STORE_BOOK);
+        return databaseRepo.storeFile(file, pathInRepo, fileName);
+    }
+
     @Override
     public VersionedRook renameBook(Uri fromUri, String name) throws IOException {
         SystemClock.sleep(SLEEP_FOR_STORE_BOOK);

app/src/main/java/com/orgzly/android/repos/SyncRepo.java

@@ -39,6 +39,16 @@ public interface SyncRepo {
      */
     VersionedRook storeBook(File file, String fileName) throws IOException;
 
+    /**
+     * Uploads file storing it under directory (pathInRepo) under repo's url.
+     * @param file The contents of this file should be stored at the remote location/repo
+     * @param pathInRepo The "/" separated path within the remote location/repo, create it if it doesn't exist
+     * @param fileName The contents ({@code file}) should be stored under this name
+     * @return {@code VersionedRook}
+     * @throws IOException
+     */
+    VersionedRook storeFile(File file, String pathInRepo, String fileName) throws IOException;
+
     VersionedRook renameBook(Uri from, String name) throws IOException;
 
     // VersionedRook moveBook(Uri from, Uri uri) throws IOException;

app/src/main/java/com/orgzly/android/repos/WebdavRepo.kt

@@ -164,6 +164,10 @@ class WebdavRepo(
         return sardine.list(fileUrl).first().toVersionedRook()
     }
 
+    override fun storeFile(file: File?, pathInRepo: String?, fileName: String?): VersionedRook {
+        TODO("Not yet implemented")
+    }
+
     override fun renameBook(from: Uri, name: String?): VersionedRook {
         val destUrl = UriUtils.getUriForNewName(from, name).toUrl()
         sardine.move(from.toUrl(), destUrl)