1 /* ownCloud Android client application
2 * Copyright (C) 2012 Bartek Przybylski
3 * Copyright (C) 2012-2013 ownCloud Inc.
5 * This program is free software: you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License version 2,
7 * as published by the Free Software Foundation.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program. If not, see <http://www.gnu.org/licenses/>.
19 package com
.owncloud
.android
.datamodel
;
22 import java
.util
.ArrayList
;
23 import java
.util
.Collections
;
24 import java
.util
.Iterator
;
25 import java
.util
.List
;
26 import java
.util
.Vector
;
28 import com
.owncloud
.android
.Log_OC
;
29 import com
.owncloud
.android
.db
.ProviderMeta
;
30 import com
.owncloud
.android
.db
.ProviderMeta
.ProviderTableMeta
;
31 import com
.owncloud
.android
.utils
.FileStorageUtils
;
33 import android
.accounts
.Account
;
34 import android
.content
.ContentProviderClient
;
35 import android
.content
.ContentProviderOperation
;
36 import android
.content
.ContentProviderResult
;
37 import android
.content
.ContentResolver
;
38 import android
.content
.ContentValues
;
39 import android
.content
.OperationApplicationException
;
40 import android
.database
.Cursor
;
41 import android
.net
.Uri
;
42 import android
.os
.RemoteException
;
44 public class FileDataStorageManager
implements DataStorageManager
{
46 private ContentResolver mContentResolver
;
47 private ContentProviderClient mContentProvider
;
48 private Account mAccount
;
50 private static String TAG
= "FileDataStorageManager";
52 public FileDataStorageManager(Account account
, ContentResolver cr
) {
53 mContentProvider
= null
;
54 mContentResolver
= cr
;
58 public FileDataStorageManager(Account account
, ContentProviderClient cp
) {
59 mContentProvider
= cp
;
60 mContentResolver
= null
;
65 public OCFile
getFileByPath(String path
) {
66 Cursor c
= getCursorForValue(ProviderTableMeta
.FILE_PATH
, path
);
68 if (c
.moveToFirst()) {
69 file
= createFileInstance(c
);
72 if (file
== null
&& OCFile
.PATH_SEPARATOR
.equals(path
)) {
73 return createRootDir(); // root should always exist
79 private OCFile
createRootDir() {
80 OCFile file
= new OCFile(OCFile
.PATH_SEPARATOR
);
81 file
.setMimetype("DIR");
82 file
.setParentId(DataStorageManager
.ROOT_PARENT_ID
);
88 public OCFile
getFileById(long id
) {
89 Cursor c
= getCursorForValue(ProviderTableMeta
._ID
, String
.valueOf(id
));
91 if (c
.moveToFirst()) {
92 file
= createFileInstance(c
);
98 public OCFile
getFileByLocalPath(String path
) {
99 Cursor c
= getCursorForValue(ProviderTableMeta
.FILE_STORAGE_PATH
, path
);
101 if (c
.moveToFirst()) {
102 file
= createFileInstance(c
);
109 public boolean fileExists(long id
) {
110 return fileExists(ProviderTableMeta
._ID
, String
.valueOf(id
));
114 public boolean fileExists(String path
) {
115 return fileExists(ProviderTableMeta
.FILE_PATH
, path
);
119 public boolean saveFile(OCFile file
) {
120 boolean overriden
= false
;
121 ContentValues cv
= new ContentValues();
122 cv
.put(ProviderTableMeta
.FILE_MODIFIED
, file
.getModificationTimestamp());
123 cv
.put(ProviderTableMeta
.FILE_MODIFIED_AT_LAST_SYNC_FOR_DATA
, file
.getModificationTimestampAtLastSyncForData());
124 cv
.put(ProviderTableMeta
.FILE_CREATION
, file
.getCreationTimestamp());
125 cv
.put(ProviderTableMeta
.FILE_CONTENT_LENGTH
, file
.getFileLength());
126 cv
.put(ProviderTableMeta
.FILE_CONTENT_TYPE
, file
.getMimetype());
127 cv
.put(ProviderTableMeta
.FILE_NAME
, file
.getFileName());
128 if (file
.getParentId() != 0)
129 cv
.put(ProviderTableMeta
.FILE_PARENT
, file
.getParentId());
130 cv
.put(ProviderTableMeta
.FILE_PATH
, file
.getRemotePath());
131 if (!file
.isDirectory())
132 cv
.put(ProviderTableMeta
.FILE_STORAGE_PATH
, file
.getStoragePath());
133 cv
.put(ProviderTableMeta
.FILE_ACCOUNT_OWNER
, mAccount
.name
);
134 cv
.put(ProviderTableMeta
.FILE_LAST_SYNC_DATE
, file
.getLastSyncDateForProperties());
135 cv
.put(ProviderTableMeta
.FILE_LAST_SYNC_DATE_FOR_DATA
, file
.getLastSyncDateForData());
136 cv
.put(ProviderTableMeta
.FILE_KEEP_IN_SYNC
, file
.keepInSync() ?
1 : 0);
138 boolean sameRemotePath
= fileExists(file
.getRemotePath());
139 if (sameRemotePath
||
140 fileExists(file
.getFileId()) ) { // for renamed files; no more delete and create
142 if (sameRemotePath
) {
143 OCFile oldFile
= getFileByPath(file
.getRemotePath());
144 file
.setFileId(oldFile
.getFileId());
148 if (getContentResolver() != null
) {
149 getContentResolver().update(ProviderTableMeta
.CONTENT_URI
, cv
,
150 ProviderTableMeta
._ID
+ "=?",
151 new String
[] { String
.valueOf(file
.getFileId()) });
154 getContentProvider().update(ProviderTableMeta
.CONTENT_URI
,
155 cv
, ProviderTableMeta
._ID
+ "=?",
156 new String
[] { String
.valueOf(file
.getFileId()) });
157 } catch (RemoteException e
) {
159 "Fail to insert insert file to database "
164 Uri result_uri
= null
;
165 if (getContentResolver() != null
) {
166 result_uri
= getContentResolver().insert(
167 ProviderTableMeta
.CONTENT_URI_FILE
, cv
);
170 result_uri
= getContentProvider().insert(
171 ProviderTableMeta
.CONTENT_URI_FILE
, cv
);
172 } catch (RemoteException e
) {
174 "Fail to insert insert file to database "
178 if (result_uri
!= null
) {
179 long new_id
= Long
.parseLong(result_uri
.getPathSegments()
181 file
.setFileId(new_id
);
185 if (file
.isDirectory() && file
.needsUpdatingWhileSaving())
186 for (OCFile f
: getDirectoryContent(file
))
194 public void saveFiles(List
<OCFile
> files
) {
196 Iterator
<OCFile
> filesIt
= files
.iterator();
197 ArrayList
<ContentProviderOperation
> operations
= new ArrayList
<ContentProviderOperation
>(files
.size());
200 // prepare operations to perform
201 while (filesIt
.hasNext()) {
202 file
= filesIt
.next();
203 ContentValues cv
= new ContentValues();
204 cv
.put(ProviderTableMeta
.FILE_MODIFIED
, file
.getModificationTimestamp());
205 cv
.put(ProviderTableMeta
.FILE_MODIFIED_AT_LAST_SYNC_FOR_DATA
, file
.getModificationTimestampAtLastSyncForData());
206 cv
.put(ProviderTableMeta
.FILE_CREATION
, file
.getCreationTimestamp());
207 cv
.put(ProviderTableMeta
.FILE_CONTENT_LENGTH
, file
.getFileLength());
208 cv
.put(ProviderTableMeta
.FILE_CONTENT_TYPE
, file
.getMimetype());
209 cv
.put(ProviderTableMeta
.FILE_NAME
, file
.getFileName());
210 if (file
.getParentId() != 0)
211 cv
.put(ProviderTableMeta
.FILE_PARENT
, file
.getParentId());
212 cv
.put(ProviderTableMeta
.FILE_PATH
, file
.getRemotePath());
213 if (!file
.isDirectory())
214 cv
.put(ProviderTableMeta
.FILE_STORAGE_PATH
, file
.getStoragePath());
215 cv
.put(ProviderTableMeta
.FILE_ACCOUNT_OWNER
, mAccount
.name
);
216 cv
.put(ProviderTableMeta
.FILE_LAST_SYNC_DATE
, file
.getLastSyncDateForProperties());
217 cv
.put(ProviderTableMeta
.FILE_LAST_SYNC_DATE_FOR_DATA
, file
.getLastSyncDateForData());
218 cv
.put(ProviderTableMeta
.FILE_KEEP_IN_SYNC
, file
.keepInSync() ?
1 : 0);
220 if (fileExists(file
.getRemotePath())) {
221 OCFile oldFile
= getFileByPath(file
.getRemotePath());
222 file
.setFileId(oldFile
.getFileId());
223 operations
.add(ContentProviderOperation
.newUpdate(ProviderTableMeta
.CONTENT_URI
).
225 withSelection( ProviderTableMeta
._ID
+ "=?",
226 new String
[] { String
.valueOf(file
.getFileId()) })
229 } else if (fileExists(file
.getFileId())) {
230 OCFile oldFile
= getFileById(file
.getFileId());
231 if (file
.getStoragePath() == null
&& oldFile
.getStoragePath() != null
)
232 file
.setStoragePath(oldFile
.getStoragePath());
233 if (!file
.isDirectory());
234 cv
.put(ProviderTableMeta
.FILE_STORAGE_PATH
, file
.getStoragePath());
236 operations
.add(ContentProviderOperation
.newUpdate(ProviderTableMeta
.CONTENT_URI
).
238 withSelection( ProviderTableMeta
._ID
+ "=?",
239 new String
[] { String
.valueOf(file
.getFileId()) })
243 operations
.add(ContentProviderOperation
.newInsert(ProviderTableMeta
.CONTENT_URI
).withValues(cv
).build());
247 // apply operations in batch
248 ContentProviderResult
[] results
= null
;
250 if (getContentResolver() != null
) {
251 results
= getContentResolver().applyBatch(ProviderMeta
.AUTHORITY_FILES
, operations
);
254 results
= getContentProvider().applyBatch(operations
);
257 } catch (OperationApplicationException e
) {
258 Log_OC
.e(TAG
, "Fail to update/insert list of files to database " + e
.getMessage());
260 } catch (RemoteException e
) {
261 Log_OC
.e(TAG
, "Fail to update/insert list of files to database " + e
.getMessage());
264 // update new id in file objects for insertions
265 if (results
!= null
) {
267 for (int i
=0; i
<results
.length
; i
++) {
268 if (results
[i
].uri
!= null
) {
269 newId
= Long
.parseLong(results
[i
].uri
.getPathSegments().get(1));
270 files
.get(i
).setFileId(newId
);
271 //Log_OC.v(TAG, "Found and added id in insertion for " + files.get(i).getRemotePath());
276 for (OCFile aFile
: files
) {
277 if (aFile
.isDirectory() && aFile
.needsUpdatingWhileSaving())
278 saveFiles(getDirectoryContent(aFile
));
283 public void setAccount(Account account
) {
287 public Account
getAccount() {
291 public void setContentResolver(ContentResolver cr
) {
292 mContentResolver
= cr
;
295 public ContentResolver
getContentResolver() {
296 return mContentResolver
;
299 public void setContentProvider(ContentProviderClient cp
) {
300 mContentProvider
= cp
;
303 public ContentProviderClient
getContentProvider() {
304 return mContentProvider
;
308 public Vector
<OCFile
> getDirectoryContent(OCFile f
) {
309 Vector
<OCFile
> ret
= new Vector
<OCFile
>();
310 if (f
!= null
&& f
.isDirectory() && f
.getFileId() != -1) {
312 Uri req_uri
= Uri
.withAppendedPath(
313 ProviderTableMeta
.CONTENT_URI_DIR
,
314 String
.valueOf(f
.getFileId()));
317 if (getContentProvider() != null
) {
319 c
= getContentProvider().query(req_uri
, null
,
320 ProviderTableMeta
.FILE_ACCOUNT_OWNER
+ "=?",
321 new String
[] { mAccount
.name
}, null
);
322 } catch (RemoteException e
) {
323 Log_OC
.e(TAG
, e
.getMessage());
327 c
= getContentResolver().query(req_uri
, null
,
328 ProviderTableMeta
.FILE_ACCOUNT_OWNER
+ "=?",
329 new String
[] { mAccount
.name
}, null
);
332 if (c
.moveToFirst()) {
334 OCFile child
= createFileInstance(c
);
336 } while (c
.moveToNext());
341 Collections
.sort(ret
);
347 private boolean fileExists(String cmp_key
, String value
) {
349 if (getContentResolver() != null
) {
350 c
= getContentResolver()
351 .query(ProviderTableMeta
.CONTENT_URI
,
354 + ProviderTableMeta
.FILE_ACCOUNT_OWNER
356 new String
[] { value
, mAccount
.name
}, null
);
359 c
= getContentProvider().query(
360 ProviderTableMeta
.CONTENT_URI
,
363 + ProviderTableMeta
.FILE_ACCOUNT_OWNER
+ "=?",
364 new String
[] { value
, mAccount
.name
}, null
);
365 } catch (RemoteException e
) {
367 "Couldn't determine file existance, assuming non existance: "
372 boolean retval
= c
.moveToFirst();
377 private Cursor
getCursorForValue(String key
, String value
) {
379 if (getContentResolver() != null
) {
380 c
= getContentResolver()
381 .query(ProviderTableMeta
.CONTENT_URI
,
384 + ProviderTableMeta
.FILE_ACCOUNT_OWNER
386 new String
[] { value
, mAccount
.name
}, null
);
389 c
= getContentProvider().query(
390 ProviderTableMeta
.CONTENT_URI
,
392 key
+ "=? AND " + ProviderTableMeta
.FILE_ACCOUNT_OWNER
393 + "=?", new String
[] { value
, mAccount
.name
},
395 } catch (RemoteException e
) {
396 Log_OC
.e(TAG
, "Could not get file details: " + e
.getMessage());
403 private OCFile
createFileInstance(Cursor c
) {
406 file
= new OCFile(c
.getString(c
407 .getColumnIndex(ProviderTableMeta
.FILE_PATH
)));
408 file
.setFileId(c
.getLong(c
.getColumnIndex(ProviderTableMeta
._ID
)));
409 file
.setParentId(c
.getLong(c
410 .getColumnIndex(ProviderTableMeta
.FILE_PARENT
)));
411 file
.setMimetype(c
.getString(c
412 .getColumnIndex(ProviderTableMeta
.FILE_CONTENT_TYPE
)));
413 if (!file
.isDirectory()) {
414 file
.setStoragePath(c
.getString(c
415 .getColumnIndex(ProviderTableMeta
.FILE_STORAGE_PATH
)));
416 if (file
.getStoragePath() == null
) {
417 // try to find existing file and bind it with current account; - with the current update of SynchronizeFolderOperation, this won't be necessary anymore after a full synchronization of the account
418 File f
= new File(FileStorageUtils
.getDefaultSavePathFor(mAccount
.name
, file
));
420 file
.setStoragePath(f
.getAbsolutePath());
421 file
.setLastSyncDateForData(f
.lastModified());
425 file
.setFileLength(c
.getLong(c
426 .getColumnIndex(ProviderTableMeta
.FILE_CONTENT_LENGTH
)));
427 file
.setCreationTimestamp(c
.getLong(c
428 .getColumnIndex(ProviderTableMeta
.FILE_CREATION
)));
429 file
.setModificationTimestamp(c
.getLong(c
430 .getColumnIndex(ProviderTableMeta
.FILE_MODIFIED
)));
431 file
.setModificationTimestampAtLastSyncForData(c
.getLong(c
432 .getColumnIndex(ProviderTableMeta
.FILE_MODIFIED_AT_LAST_SYNC_FOR_DATA
)));
433 file
.setLastSyncDateForProperties(c
.getLong(c
434 .getColumnIndex(ProviderTableMeta
.FILE_LAST_SYNC_DATE
)));
435 file
.setLastSyncDateForData(c
.getLong(c
.
436 getColumnIndex(ProviderTableMeta
.FILE_LAST_SYNC_DATE_FOR_DATA
)));
437 file
.setKeepInSync(c
.getInt(
438 c
.getColumnIndex(ProviderTableMeta
.FILE_KEEP_IN_SYNC
)) == 1 ? true
: false
);
444 public void removeFile(OCFile file
, boolean removeLocalCopy
) {
445 Uri file_uri
= Uri
.withAppendedPath(ProviderTableMeta
.CONTENT_URI_FILE
, ""+file
.getFileId());
446 if (getContentProvider() != null
) {
448 getContentProvider().delete(file_uri
,
449 ProviderTableMeta
.FILE_ACCOUNT_OWNER
+"=?",
450 new String
[]{mAccount
.name
});
451 } catch (RemoteException e
) {
455 getContentResolver().delete(file_uri
,
456 ProviderTableMeta
.FILE_ACCOUNT_OWNER
+"=?",
457 new String
[]{mAccount
.name
});
459 if (file
.isDown() && removeLocalCopy
) {
460 new File(file
.getStoragePath()).delete();
462 if (file
.isDirectory() && removeLocalCopy
) {
463 File f
= new File(FileStorageUtils
.getDefaultSavePathFor(mAccount
.name
, file
));
464 if (f
.exists() && f
.isDirectory() && (f
.list() == null
|| f
.list().length
== 0)) {
469 updateSubtreeSize(file
.getParentId());
473 public void removeDirectory(OCFile dir
, boolean removeDBData
, boolean removeLocalContent
) {
474 // TODO consider possible failures
475 if (dir
!= null
&& dir
.isDirectory() && dir
.getFileId() != -1) {
476 Vector
<OCFile
> children
= getDirectoryContent(dir
);
477 if (children
.size() > 0) {
479 for (int i
=0; i
<children
.size(); i
++) {
480 child
= children
.get(i
);
481 if (child
.isDirectory()) {
482 removeDirectory(child
, removeDBData
, removeLocalContent
);
485 removeFile(child
, removeLocalContent
);
486 } else if (removeLocalContent
) {
487 if (child
.isDown()) {
488 new File(child
.getStoragePath()).delete();
495 removeFile(dir
, true
);
502 * Updates database for a folder that was moved to a different location.
504 * TODO explore better (faster) implementations
505 * TODO throw exceptions up !
508 public void moveDirectory(OCFile dir
, String newPath
) {
509 // TODO check newPath
511 if (dir
!= null
&& dir
.isDirectory() && dir
.fileExists() && !dir
.getFileName().equals(OCFile
.PATH_SEPARATOR
)) {
512 /// 1. get all the descendants of 'dir' in a single QUERY (including 'dir')
514 if (getContentProvider() != null
) {
516 c
= getContentProvider().query(ProviderTableMeta
.CONTENT_URI
,
518 ProviderTableMeta
.FILE_ACCOUNT_OWNER
+ "=? AND " + ProviderTableMeta
.FILE_PATH
+ " LIKE ?",
519 new String
[] { mAccount
.name
, dir
.getRemotePath() + "%" }, null
);
520 } catch (RemoteException e
) {
521 Log_OC
.e(TAG
, e
.getMessage());
524 c
= getContentResolver().query(ProviderTableMeta
.CONTENT_URI
,
526 ProviderTableMeta
.FILE_ACCOUNT_OWNER
+ "=? AND " + ProviderTableMeta
.FILE_PATH
+ " LIKE ?",
527 new String
[] { mAccount
.name
, dir
.getRemotePath() + "%" }, null
);
530 /// 2. prepare a batch of update operations to change all the descendants
531 ArrayList
<ContentProviderOperation
> operations
= new ArrayList
<ContentProviderOperation
>(c
.getCount());
532 int lengthOfOldPath
= dir
.getRemotePath().length();
533 String defaultSavePath
= FileStorageUtils
.getSavePath(mAccount
.name
);
534 int lengthOfOldStoragePath
= defaultSavePath
.length() + lengthOfOldPath
;
535 if (c
.moveToFirst()) {
537 ContentValues cv
= new ContentValues(); // don't take the constructor out of the loop and clear the object
538 OCFile child
= createFileInstance(c
);
539 cv
.put(ProviderTableMeta
.FILE_PATH
, newPath
+ child
.getRemotePath().substring(lengthOfOldPath
));
540 if (child
.getStoragePath() != null
&& child
.getStoragePath().startsWith(defaultSavePath
)) {
541 cv
.put(ProviderTableMeta
.FILE_STORAGE_PATH
, defaultSavePath
+ newPath
+ child
.getStoragePath().substring(lengthOfOldStoragePath
));
543 operations
.add(ContentProviderOperation
.newUpdate(ProviderTableMeta
.CONTENT_URI
).
545 withSelection( ProviderTableMeta
._ID
+ "=?",
546 new String
[] { String
.valueOf(child
.getFileId()) })
548 } while (c
.moveToNext());
552 /// 3. apply updates in batch
554 if (getContentResolver() != null
) {
555 getContentResolver().applyBatch(ProviderMeta
.AUTHORITY_FILES
, operations
);
558 getContentProvider().applyBatch(operations
);
561 } catch (OperationApplicationException e
) {
562 Log_OC
.e(TAG
, "Fail to update descendants of " + dir
.getFileId() + " in database", e
);
564 } catch (RemoteException e
) {
565 Log_OC
.e(TAG
, "Fail to update desendants of " + dir
.getFileId() + " in database", e
);
572 public Vector
<OCFile
> getDirectoryImages(OCFile directory
) {
573 Vector
<OCFile
> ret
= new Vector
<OCFile
>();
574 if (directory
!= null
) {
575 // TODO better implementation, filtering in the access to database (if possible) instead of here
576 Vector
<OCFile
> tmp
= getDirectoryContent(directory
);
577 OCFile current
= null
;
578 for (int i
=0; i
<tmp
.size(); i
++) {
579 current
= tmp
.get(i
);
580 if (current
.isImage()) {
589 public Vector
<OCFile
> getFilesbyParent(long parentId
) {
591 Vector
<OCFile
> ret
= new Vector
<OCFile
>();
593 Uri req_uri
= Uri
.withAppendedPath(
594 ProviderTableMeta
.CONTENT_URI_DIR
,
595 String
.valueOf(parentId
));
598 if (getContentProvider() != null
) {
600 c
= getContentProvider().query(req_uri
, null
,
601 ProviderTableMeta
.FILE_PARENT
+ "=?" ,
602 new String
[] { String
.valueOf(parentId
)}, null
);
603 } catch (RemoteException e
) {
604 Log_OC
.e(TAG
, e
.getMessage());
608 c
= getContentResolver().query(req_uri
, null
,
609 ProviderTableMeta
.FILE_PARENT
+ "=?" ,
610 new String
[] { String
.valueOf(parentId
)}, null
);
613 if (c
.moveToFirst()) {
615 OCFile child
= createFileInstance(c
);
617 } while (c
.moveToNext());
622 Collections
.sort(ret
);
628 * Calculate and save the folderSize on DB
632 public void saveFolderSize(long id
) {
635 Vector
<OCFile
> files
= getFilesbyParent(id
);
637 Log_OC
.d(TAG
, "Folder " + String
.valueOf(id
) + "--- Number of Files = " + String
.valueOf(files
.size()));
639 for (OCFile f
: files
)
641 folderSize
= folderSize
+ f
.getFileLength();
642 Log_OC
.d(TAG
, "Folder Size = " + String
.valueOf(folderSize
));
645 updatefolderSize(id
, folderSize
);
649 * Update the size value of a folder on DB
652 public int updatefolderSize(long id
, long size
) {
653 ContentValues cv
= new ContentValues();
654 cv
.put(ProviderTableMeta
.FILE_CONTENT_LENGTH
, size
);
655 int result
= getContentResolver().update(ProviderTableMeta
.CONTENT_URI
, cv
, ProviderTableMeta
._ID
+ "=?",
656 new String
[] { String
.valueOf(id
) });
661 * Update the size of a subtree of folder from a file to the root
662 * @param parentId: parent of the file
664 private void updateSubtreeSize(long parentId
) {
668 while (parentId
!= 0) {
670 Log_OC
.d(TAG
, "parent = " + parentId
);
671 // Update the size of the parent
672 saveFolderSize(parentId
);
674 // search the next parent
675 file
= getFileById(parentId
);
676 parentId
= file
.getParentId();