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
.DisplayUtils
;
29 import com
.owncloud
.android
.Log_OC
;
30 import com
.owncloud
.android
.db
.ProviderMeta
;
31 import com
.owncloud
.android
.db
.ProviderMeta
.ProviderTableMeta
;
32 import com
.owncloud
.android
.utils
.FileStorageUtils
;
34 import android
.accounts
.Account
;
35 import android
.content
.ContentProviderClient
;
36 import android
.content
.ContentProviderOperation
;
37 import android
.content
.ContentProviderResult
;
38 import android
.content
.ContentResolver
;
39 import android
.content
.ContentValues
;
40 import android
.content
.OperationApplicationException
;
41 import android
.database
.Cursor
;
42 import android
.net
.Uri
;
43 import android
.os
.RemoteException
;
45 public class FileDataStorageManager
implements DataStorageManager
{
47 private ContentResolver mContentResolver
;
48 private ContentProviderClient mContentProvider
;
49 private Account mAccount
;
51 private static String TAG
= "FileDataStorageManager";
53 public FileDataStorageManager(Account account
, ContentResolver cr
) {
54 mContentProvider
= null
;
55 mContentResolver
= cr
;
59 public FileDataStorageManager(Account account
, ContentProviderClient cp
) {
60 mContentProvider
= cp
;
61 mContentResolver
= null
;
66 public OCFile
getFileByPath(String path
) {
67 Cursor c
= getCursorForValue(ProviderTableMeta
.FILE_PATH
, path
);
69 if (c
.moveToFirst()) {
70 file
= createFileInstance(c
);
73 if (file
== null
&& OCFile
.PATH_SEPARATOR
.equals(path
)) {
74 return createRootDir(); // root should always exist
80 private OCFile
createRootDir() {
81 OCFile file
= new OCFile(OCFile
.PATH_SEPARATOR
);
82 file
.setMimetype("DIR");
83 file
.setParentId(DataStorageManager
.ROOT_PARENT_ID
);
89 public OCFile
getFileById(long id
) {
90 Cursor c
= getCursorForValue(ProviderTableMeta
._ID
, String
.valueOf(id
));
92 if (c
.moveToFirst()) {
93 file
= createFileInstance(c
);
99 public OCFile
getFileByLocalPath(String path
) {
100 Cursor c
= getCursorForValue(ProviderTableMeta
.FILE_STORAGE_PATH
, path
);
102 if (c
.moveToFirst()) {
103 file
= createFileInstance(c
);
110 public boolean fileExists(long id
) {
111 return fileExists(ProviderTableMeta
._ID
, String
.valueOf(id
));
115 public boolean fileExists(String path
) {
116 return fileExists(ProviderTableMeta
.FILE_PATH
, path
);
120 public boolean saveFile(OCFile file
) {
121 boolean overriden
= false
;
122 ContentValues cv
= new ContentValues();
123 cv
.put(ProviderTableMeta
.FILE_MODIFIED
, file
.getModificationTimestamp());
124 cv
.put(ProviderTableMeta
.FILE_MODIFIED_AT_LAST_SYNC_FOR_DATA
, file
.getModificationTimestampAtLastSyncForData());
125 cv
.put(ProviderTableMeta
.FILE_CREATION
, file
.getCreationTimestamp());
126 cv
.put(ProviderTableMeta
.FILE_CONTENT_LENGTH
, file
.getFileLength());
127 cv
.put(ProviderTableMeta
.FILE_CONTENT_TYPE
, file
.getMimetype());
128 cv
.put(ProviderTableMeta
.FILE_NAME
, file
.getFileName());
129 if (file
.getParentId() != 0)
130 cv
.put(ProviderTableMeta
.FILE_PARENT
, file
.getParentId());
131 cv
.put(ProviderTableMeta
.FILE_PATH
, file
.getRemotePath());
132 if (!file
.isDirectory())
133 cv
.put(ProviderTableMeta
.FILE_STORAGE_PATH
, file
.getStoragePath());
134 cv
.put(ProviderTableMeta
.FILE_ACCOUNT_OWNER
, mAccount
.name
);
135 cv
.put(ProviderTableMeta
.FILE_LAST_SYNC_DATE
, file
.getLastSyncDateForProperties());
136 cv
.put(ProviderTableMeta
.FILE_LAST_SYNC_DATE_FOR_DATA
, file
.getLastSyncDateForData());
137 cv
.put(ProviderTableMeta
.FILE_KEEP_IN_SYNC
, file
.keepInSync() ?
1 : 0);
139 boolean sameRemotePath
= fileExists(file
.getRemotePath());
140 boolean changesSizeOfAncestors
= false
;
141 if (sameRemotePath
||
142 fileExists(file
.getFileId()) ) { // for renamed files; no more delete and create
144 OCFile oldFile
= null
;
145 if (sameRemotePath
) {
146 oldFile
= getFileByPath(file
.getRemotePath());
147 file
.setFileId(oldFile
.getFileId());
149 oldFile
= getFileById(file
.getFileId());
151 changesSizeOfAncestors
= (oldFile
.getFileLength() != file
.getFileLength());
154 if (getContentResolver() != null
) {
155 getContentResolver().update(ProviderTableMeta
.CONTENT_URI
, cv
,
156 ProviderTableMeta
._ID
+ "=?",
157 new String
[] { String
.valueOf(file
.getFileId()) });
160 getContentProvider().update(ProviderTableMeta
.CONTENT_URI
,
161 cv
, ProviderTableMeta
._ID
+ "=?",
162 new String
[] { String
.valueOf(file
.getFileId()) });
163 } catch (RemoteException e
) {
165 "Fail to insert insert file to database "
170 changesSizeOfAncestors
= true
;
171 Uri result_uri
= null
;
172 if (getContentResolver() != null
) {
173 result_uri
= getContentResolver().insert(
174 ProviderTableMeta
.CONTENT_URI_FILE
, cv
);
177 result_uri
= getContentProvider().insert(
178 ProviderTableMeta
.CONTENT_URI_FILE
, cv
);
179 } catch (RemoteException e
) {
181 "Fail to insert insert file to database "
185 if (result_uri
!= null
) {
186 long new_id
= Long
.parseLong(result_uri
.getPathSegments()
188 file
.setFileId(new_id
);
192 if (file
.isDirectory()) {
193 calculateFolderSize(file
.getFileId());
194 if (file
.needsUpdatingWhileSaving()) {
195 for (OCFile f
: getDirectoryContent(file
))
200 if (changesSizeOfAncestors
|| file
.isDirectory()) {
201 updateSizesToTheRoot(file
.getParentId());
209 public void saveFiles(List
<OCFile
> files
) {
211 Iterator
<OCFile
> filesIt
= files
.iterator();
212 ArrayList
<ContentProviderOperation
> operations
= new ArrayList
<ContentProviderOperation
>(files
.size());
215 // prepare operations to perform
216 while (filesIt
.hasNext()) {
217 file
= filesIt
.next();
218 ContentValues cv
= new ContentValues();
219 cv
.put(ProviderTableMeta
.FILE_MODIFIED
, file
.getModificationTimestamp());
220 cv
.put(ProviderTableMeta
.FILE_MODIFIED_AT_LAST_SYNC_FOR_DATA
, file
.getModificationTimestampAtLastSyncForData());
221 cv
.put(ProviderTableMeta
.FILE_CREATION
, file
.getCreationTimestamp());
222 cv
.put(ProviderTableMeta
.FILE_CONTENT_LENGTH
, file
.getFileLength());
223 cv
.put(ProviderTableMeta
.FILE_CONTENT_TYPE
, file
.getMimetype());
224 cv
.put(ProviderTableMeta
.FILE_NAME
, file
.getFileName());
225 if (file
.getParentId() != 0)
226 cv
.put(ProviderTableMeta
.FILE_PARENT
, file
.getParentId());
227 cv
.put(ProviderTableMeta
.FILE_PATH
, file
.getRemotePath());
228 if (!file
.isDirectory())
229 cv
.put(ProviderTableMeta
.FILE_STORAGE_PATH
, file
.getStoragePath());
230 cv
.put(ProviderTableMeta
.FILE_ACCOUNT_OWNER
, mAccount
.name
);
231 cv
.put(ProviderTableMeta
.FILE_LAST_SYNC_DATE
, file
.getLastSyncDateForProperties());
232 cv
.put(ProviderTableMeta
.FILE_LAST_SYNC_DATE_FOR_DATA
, file
.getLastSyncDateForData());
233 cv
.put(ProviderTableMeta
.FILE_KEEP_IN_SYNC
, file
.keepInSync() ?
1 : 0);
235 if (fileExists(file
.getRemotePath())) {
236 OCFile oldFile
= getFileByPath(file
.getRemotePath());
237 file
.setFileId(oldFile
.getFileId());
238 operations
.add(ContentProviderOperation
.newUpdate(ProviderTableMeta
.CONTENT_URI
).
240 withSelection( ProviderTableMeta
._ID
+ "=?",
241 new String
[] { String
.valueOf(file
.getFileId()) })
244 } else if (fileExists(file
.getFileId())) {
245 OCFile oldFile
= getFileById(file
.getFileId());
246 if (file
.getStoragePath() == null
&& oldFile
.getStoragePath() != null
)
247 file
.setStoragePath(oldFile
.getStoragePath());
248 if (!file
.isDirectory());
249 cv
.put(ProviderTableMeta
.FILE_STORAGE_PATH
, file
.getStoragePath());
251 operations
.add(ContentProviderOperation
.newUpdate(ProviderTableMeta
.CONTENT_URI
).
253 withSelection( ProviderTableMeta
._ID
+ "=?",
254 new String
[] { String
.valueOf(file
.getFileId()) })
258 operations
.add(ContentProviderOperation
.newInsert(ProviderTableMeta
.CONTENT_URI
).withValues(cv
).build());
262 // apply operations in batch
263 ContentProviderResult
[] results
= null
;
265 if (getContentResolver() != null
) {
266 results
= getContentResolver().applyBatch(ProviderMeta
.AUTHORITY_FILES
, operations
);
269 results
= getContentProvider().applyBatch(operations
);
272 } catch (OperationApplicationException e
) {
273 Log_OC
.e(TAG
, "Fail to update/insert list of files to database " + e
.getMessage());
275 } catch (RemoteException e
) {
276 Log_OC
.e(TAG
, "Fail to update/insert list of files to database " + e
.getMessage());
279 // update new id in file objects for insertions
280 if (results
!= null
) {
282 for (int i
=0; i
<results
.length
; i
++) {
283 if (results
[i
].uri
!= null
) {
284 newId
= Long
.parseLong(results
[i
].uri
.getPathSegments().get(1));
285 files
.get(i
).setFileId(newId
);
286 //Log_OC.v(TAG, "Found and added id in insertion for " + files.get(i).getRemotePath());
291 for (OCFile aFile
: files
) {
292 if (aFile
.isDirectory() && aFile
.needsUpdatingWhileSaving())
293 saveFiles(getDirectoryContent(aFile
));
298 public void setAccount(Account account
) {
302 public Account
getAccount() {
306 public void setContentResolver(ContentResolver cr
) {
307 mContentResolver
= cr
;
310 public ContentResolver
getContentResolver() {
311 return mContentResolver
;
314 public void setContentProvider(ContentProviderClient cp
) {
315 mContentProvider
= cp
;
318 public ContentProviderClient
getContentProvider() {
319 return mContentProvider
;
323 public Vector
<OCFile
> getDirectoryContent(OCFile f
) {
324 if (f
!= null
&& f
.isDirectory() && f
.getFileId() != -1) {
325 return getDirectoryContent(f
.getFileId());
328 return new Vector
<OCFile
>();
332 private Vector
<OCFile
> getDirectoryContent(long parentId
) {
334 Vector
<OCFile
> ret
= new Vector
<OCFile
>();
336 Uri req_uri
= Uri
.withAppendedPath(
337 ProviderTableMeta
.CONTENT_URI_DIR
,
338 String
.valueOf(parentId
));
341 if (getContentProvider() != null
) {
343 c
= getContentProvider().query(req_uri
, null
,
344 ProviderTableMeta
.FILE_PARENT
+ "=?" ,
345 new String
[] { String
.valueOf(parentId
)}, null
);
346 } catch (RemoteException e
) {
347 Log_OC
.e(TAG
, e
.getMessage());
351 c
= getContentResolver().query(req_uri
, null
,
352 ProviderTableMeta
.FILE_PARENT
+ "=?" ,
353 new String
[] { String
.valueOf(parentId
)}, null
);
356 if (c
.moveToFirst()) {
358 OCFile child
= createFileInstance(c
);
360 } while (c
.moveToNext());
365 Collections
.sort(ret
);
372 private boolean fileExists(String cmp_key
, String value
) {
374 if (getContentResolver() != null
) {
375 c
= getContentResolver()
376 .query(ProviderTableMeta
.CONTENT_URI
,
379 + ProviderTableMeta
.FILE_ACCOUNT_OWNER
381 new String
[] { value
, mAccount
.name
}, null
);
384 c
= getContentProvider().query(
385 ProviderTableMeta
.CONTENT_URI
,
388 + ProviderTableMeta
.FILE_ACCOUNT_OWNER
+ "=?",
389 new String
[] { value
, mAccount
.name
}, null
);
390 } catch (RemoteException e
) {
392 "Couldn't determine file existance, assuming non existance: "
397 boolean retval
= c
.moveToFirst();
402 private Cursor
getCursorForValue(String key
, String value
) {
404 if (getContentResolver() != null
) {
405 c
= getContentResolver()
406 .query(ProviderTableMeta
.CONTENT_URI
,
409 + ProviderTableMeta
.FILE_ACCOUNT_OWNER
411 new String
[] { value
, mAccount
.name
}, null
);
414 c
= getContentProvider().query(
415 ProviderTableMeta
.CONTENT_URI
,
417 key
+ "=? AND " + ProviderTableMeta
.FILE_ACCOUNT_OWNER
418 + "=?", new String
[] { value
, mAccount
.name
},
420 } catch (RemoteException e
) {
421 Log_OC
.e(TAG
, "Could not get file details: " + e
.getMessage());
428 private OCFile
createFileInstance(Cursor c
) {
431 file
= new OCFile(c
.getString(c
432 .getColumnIndex(ProviderTableMeta
.FILE_PATH
)));
433 file
.setFileId(c
.getLong(c
.getColumnIndex(ProviderTableMeta
._ID
)));
434 file
.setParentId(c
.getLong(c
435 .getColumnIndex(ProviderTableMeta
.FILE_PARENT
)));
436 file
.setMimetype(c
.getString(c
437 .getColumnIndex(ProviderTableMeta
.FILE_CONTENT_TYPE
)));
438 if (!file
.isDirectory()) {
439 file
.setStoragePath(c
.getString(c
440 .getColumnIndex(ProviderTableMeta
.FILE_STORAGE_PATH
)));
441 if (file
.getStoragePath() == null
) {
442 // 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
443 File f
= new File(FileStorageUtils
.getDefaultSavePathFor(mAccount
.name
, file
));
445 file
.setStoragePath(f
.getAbsolutePath());
446 file
.setLastSyncDateForData(f
.lastModified());
450 file
.setFileLength(c
.getLong(c
451 .getColumnIndex(ProviderTableMeta
.FILE_CONTENT_LENGTH
)));
452 file
.setCreationTimestamp(c
.getLong(c
453 .getColumnIndex(ProviderTableMeta
.FILE_CREATION
)));
454 file
.setModificationTimestamp(c
.getLong(c
455 .getColumnIndex(ProviderTableMeta
.FILE_MODIFIED
)));
456 file
.setModificationTimestampAtLastSyncForData(c
.getLong(c
457 .getColumnIndex(ProviderTableMeta
.FILE_MODIFIED_AT_LAST_SYNC_FOR_DATA
)));
458 file
.setLastSyncDateForProperties(c
.getLong(c
459 .getColumnIndex(ProviderTableMeta
.FILE_LAST_SYNC_DATE
)));
460 file
.setLastSyncDateForData(c
.getLong(c
.
461 getColumnIndex(ProviderTableMeta
.FILE_LAST_SYNC_DATE_FOR_DATA
)));
462 file
.setKeepInSync(c
.getInt(
463 c
.getColumnIndex(ProviderTableMeta
.FILE_KEEP_IN_SYNC
)) == 1 ? true
: false
);
469 public void removeFile(OCFile file
, boolean removeLocalCopy
) {
470 Uri file_uri
= Uri
.withAppendedPath(ProviderTableMeta
.CONTENT_URI_FILE
, ""+file
.getFileId());
471 if (getContentProvider() != null
) {
473 getContentProvider().delete(file_uri
,
474 ProviderTableMeta
.FILE_ACCOUNT_OWNER
+"=?",
475 new String
[]{mAccount
.name
});
476 } catch (RemoteException e
) {
480 getContentResolver().delete(file_uri
,
481 ProviderTableMeta
.FILE_ACCOUNT_OWNER
+"=?",
482 new String
[]{mAccount
.name
});
484 if (file
.isDown() && removeLocalCopy
) {
485 new File(file
.getStoragePath()).delete();
487 if (file
.isDirectory() && removeLocalCopy
) {
488 File f
= new File(FileStorageUtils
.getDefaultSavePathFor(mAccount
.name
, file
));
489 if (f
.exists() && f
.isDirectory() && (f
.list() == null
|| f
.list().length
== 0)) {
494 if (file
.getFileLength() > 0) {
495 updateSizesToTheRoot(file
.getParentId());
500 public void removeDirectory(OCFile dir
, boolean removeDBData
, boolean removeLocalContent
) {
501 // TODO consider possible failures
502 if (dir
!= null
&& dir
.isDirectory() && dir
.getFileId() != -1) {
503 Vector
<OCFile
> children
= getDirectoryContent(dir
);
504 if (children
.size() > 0) {
506 for (int i
=0; i
<children
.size(); i
++) {
507 child
= children
.get(i
);
508 if (child
.isDirectory()) {
509 removeDirectory(child
, removeDBData
, removeLocalContent
);
512 removeFile(child
, removeLocalContent
);
513 } else if (removeLocalContent
) {
514 if (child
.isDown()) {
515 new File(child
.getStoragePath()).delete();
522 removeFile(dir
, true
);
525 if (dir
.getFileLength() > 0) {
526 updateSizesToTheRoot(dir
.getParentId());
533 * Updates database for a folder that was moved to a different location.
535 * TODO explore better (faster) implementations
536 * TODO throw exceptions up !
539 public void moveDirectory(OCFile dir
, String newPath
) {
540 // TODO check newPath
542 if (dir
!= null
&& dir
.isDirectory() && dir
.fileExists() && !dir
.getFileName().equals(OCFile
.PATH_SEPARATOR
)) {
543 /// 1. get all the descendants of 'dir' in a single QUERY (including 'dir')
545 if (getContentProvider() != null
) {
547 c
= getContentProvider().query(ProviderTableMeta
.CONTENT_URI
,
549 ProviderTableMeta
.FILE_ACCOUNT_OWNER
+ "=? AND " + ProviderTableMeta
.FILE_PATH
+ " LIKE ?",
550 new String
[] { mAccount
.name
, dir
.getRemotePath() + "%" }, null
);
551 } catch (RemoteException e
) {
552 Log_OC
.e(TAG
, e
.getMessage());
555 c
= getContentResolver().query(ProviderTableMeta
.CONTENT_URI
,
557 ProviderTableMeta
.FILE_ACCOUNT_OWNER
+ "=? AND " + ProviderTableMeta
.FILE_PATH
+ " LIKE ?",
558 new String
[] { mAccount
.name
, dir
.getRemotePath() + "%" }, null
);
561 /// 2. prepare a batch of update operations to change all the descendants
562 ArrayList
<ContentProviderOperation
> operations
= new ArrayList
<ContentProviderOperation
>(c
.getCount());
563 int lengthOfOldPath
= dir
.getRemotePath().length();
564 String defaultSavePath
= FileStorageUtils
.getSavePath(mAccount
.name
);
565 int lengthOfOldStoragePath
= defaultSavePath
.length() + lengthOfOldPath
;
566 if (c
.moveToFirst()) {
568 ContentValues cv
= new ContentValues(); // don't take the constructor out of the loop and clear the object
569 OCFile child
= createFileInstance(c
);
570 cv
.put(ProviderTableMeta
.FILE_PATH
, newPath
+ child
.getRemotePath().substring(lengthOfOldPath
));
571 if (child
.getStoragePath() != null
&& child
.getStoragePath().startsWith(defaultSavePath
)) {
572 cv
.put(ProviderTableMeta
.FILE_STORAGE_PATH
, defaultSavePath
+ newPath
+ child
.getStoragePath().substring(lengthOfOldStoragePath
));
574 operations
.add(ContentProviderOperation
.newUpdate(ProviderTableMeta
.CONTENT_URI
).
576 withSelection( ProviderTableMeta
._ID
+ "=?",
577 new String
[] { String
.valueOf(child
.getFileId()) })
579 } while (c
.moveToNext());
583 /// 3. apply updates in batch
585 if (getContentResolver() != null
) {
586 getContentResolver().applyBatch(ProviderMeta
.AUTHORITY_FILES
, operations
);
589 getContentProvider().applyBatch(operations
);
592 } catch (OperationApplicationException e
) {
593 Log_OC
.e(TAG
, "Fail to update descendants of " + dir
.getFileId() + " in database", e
);
595 } catch (RemoteException e
) {
596 Log_OC
.e(TAG
, "Fail to update desendants of " + dir
.getFileId() + " in database", e
);
603 public Vector
<OCFile
> getDirectoryImages(OCFile directory
) {
604 Vector
<OCFile
> ret
= new Vector
<OCFile
>();
605 if (directory
!= null
) {
606 // TODO better implementation, filtering in the access to database (if possible) instead of here
607 Vector
<OCFile
> tmp
= getDirectoryContent(directory
);
608 OCFile current
= null
;
609 for (int i
=0; i
<tmp
.size(); i
++) {
610 current
= tmp
.get(i
);
611 if (current
.isImage()) {
620 * Calculate and save the folderSize on DB
624 public void calculateFolderSize(long id
) {
627 Vector
<OCFile
> files
= getDirectoryContent(id
);
629 for (OCFile f
: files
)
631 folderSize
= folderSize
+ f
.getFileLength();
634 updateSize(id
, folderSize
);
638 * Update the size value of an OCFile in DB
640 private int updateSize(long id
, long size
) {
641 ContentValues cv
= new ContentValues();
642 cv
.put(ProviderTableMeta
.FILE_CONTENT_LENGTH
, size
);
644 if (getContentResolver() != null
) {
645 result
= getContentResolver().update(ProviderTableMeta
.CONTENT_URI
, cv
, ProviderTableMeta
._ID
+ "=?",
646 new String
[] { String
.valueOf(id
) });
649 result
= getContentProvider().update(ProviderTableMeta
.CONTENT_URI
, cv
, ProviderTableMeta
._ID
+ "=?",
650 new String
[] { String
.valueOf(id
) });
651 } catch (RemoteException e
) {
652 Log_OC
.e(TAG
,"Fail to update size column into database " + e
.getMessage());
659 * Update the size of a subtree of folder from a file to the root
660 * @param parentId: parent of the file
662 private void updateSizesToTheRoot(long parentId
) {
666 while (parentId
!= 0) {
668 Log_OC
.d(TAG
, "parent = " + parentId
);
669 // Update the size of the parent
670 calculateFolderSize(parentId
);
672 // search the next parent
673 file
= getFileById(parentId
);
674 parentId
= file
.getParentId();