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
.MainApp
;
30 import com
.owncloud
.android
.db
.ProviderMeta
.ProviderTableMeta
;
31 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());
239 if (file
.isDirectory()) {
240 cv
.put(ProviderTableMeta
.FILE_CONTENT_LENGTH
, oldFile
.getFileLength());
241 file
.setFileLength(oldFile
.getFileLength());
244 operations
.add(ContentProviderOperation
.newUpdate(ProviderTableMeta
.CONTENT_URI
).
246 withSelection( ProviderTableMeta
._ID
+ "=?",
247 new String
[] { String
.valueOf(file
.getFileId()) })
250 } else if (fileExists(file
.getFileId())) {
251 OCFile oldFile
= getFileById(file
.getFileId());
252 if (file
.getStoragePath() == null
&& oldFile
.getStoragePath() != null
)
253 file
.setStoragePath(oldFile
.getStoragePath());
255 if (!file
.isDirectory())
256 cv
.put(ProviderTableMeta
.FILE_STORAGE_PATH
, file
.getStoragePath());
258 cv
.put(ProviderTableMeta
.FILE_CONTENT_LENGTH
, oldFile
.getFileLength());
259 file
.setFileLength(oldFile
.getFileLength());
262 operations
.add(ContentProviderOperation
.newUpdate(ProviderTableMeta
.CONTENT_URI
).
264 withSelection( ProviderTableMeta
._ID
+ "=?",
265 new String
[] { String
.valueOf(file
.getFileId()) })
269 operations
.add(ContentProviderOperation
.newInsert(ProviderTableMeta
.CONTENT_URI
).withValues(cv
).build());
273 // apply operations in batch
274 ContentProviderResult
[] results
= null
;
276 if (getContentResolver() != null
) {
277 results
= getContentResolver().applyBatch(MainApp
.getAuthority(), operations
);
280 results
= getContentProvider().applyBatch(operations
);
283 } catch (OperationApplicationException e
) {
284 Log_OC
.e(TAG
, "Fail to update/insert list of files to database " + e
.getMessage());
286 } catch (RemoteException e
) {
287 Log_OC
.e(TAG
, "Fail to update/insert list of files to database " + e
.getMessage());
290 // update new id in file objects for insertions
291 if (results
!= null
) {
293 for (int i
=0; i
<results
.length
; i
++) {
294 if (results
[i
].uri
!= null
) {
295 newId
= Long
.parseLong(results
[i
].uri
.getPathSegments().get(1));
296 files
.get(i
).setFileId(newId
);
297 //Log_OC.v(TAG, "Found and added id in insertion for " + files.get(i).getRemotePath());
302 for (OCFile aFile
: files
) {
303 if (aFile
.isDirectory() && aFile
.needsUpdatingWhileSaving())
304 saveFiles(getDirectoryContent(aFile
));
309 public void setAccount(Account account
) {
313 public Account
getAccount() {
317 public void setContentResolver(ContentResolver cr
) {
318 mContentResolver
= cr
;
321 public ContentResolver
getContentResolver() {
322 return mContentResolver
;
325 public void setContentProvider(ContentProviderClient cp
) {
326 mContentProvider
= cp
;
329 public ContentProviderClient
getContentProvider() {
330 return mContentProvider
;
334 public Vector
<OCFile
> getDirectoryContent(OCFile f
) {
335 if (f
!= null
&& f
.isDirectory() && f
.getFileId() != -1) {
336 return getDirectoryContent(f
.getFileId());
339 return new Vector
<OCFile
>();
343 private Vector
<OCFile
> getDirectoryContent(long parentId
) {
345 Vector
<OCFile
> ret
= new Vector
<OCFile
>();
347 Uri req_uri
= Uri
.withAppendedPath(
348 ProviderTableMeta
.CONTENT_URI_DIR
,
349 String
.valueOf(parentId
));
352 if (getContentProvider() != null
) {
354 c
= getContentProvider().query(req_uri
, null
,
355 ProviderTableMeta
.FILE_PARENT
+ "=?" ,
356 new String
[] { String
.valueOf(parentId
)}, null
);
357 } catch (RemoteException e
) {
358 Log_OC
.e(TAG
, e
.getMessage());
362 c
= getContentResolver().query(req_uri
, null
,
363 ProviderTableMeta
.FILE_PARENT
+ "=?" ,
364 new String
[] { String
.valueOf(parentId
)}, null
);
367 if (c
.moveToFirst()) {
369 OCFile child
= createFileInstance(c
);
371 } while (c
.moveToNext());
376 Collections
.sort(ret
);
383 private boolean fileExists(String cmp_key
, String value
) {
385 if (getContentResolver() != null
) {
386 c
= getContentResolver()
387 .query(ProviderTableMeta
.CONTENT_URI
,
390 + ProviderTableMeta
.FILE_ACCOUNT_OWNER
392 new String
[] { value
, mAccount
.name
}, null
);
395 c
= getContentProvider().query(
396 ProviderTableMeta
.CONTENT_URI
,
399 + ProviderTableMeta
.FILE_ACCOUNT_OWNER
+ "=?",
400 new String
[] { value
, mAccount
.name
}, null
);
401 } catch (RemoteException e
) {
403 "Couldn't determine file existance, assuming non existance: "
408 boolean retval
= c
.moveToFirst();
413 private Cursor
getCursorForValue(String key
, String value
) {
415 if (getContentResolver() != null
) {
416 c
= getContentResolver()
417 .query(ProviderTableMeta
.CONTENT_URI
,
420 + ProviderTableMeta
.FILE_ACCOUNT_OWNER
422 new String
[] { value
, mAccount
.name
}, null
);
425 c
= getContentProvider().query(
426 ProviderTableMeta
.CONTENT_URI
,
428 key
+ "=? AND " + ProviderTableMeta
.FILE_ACCOUNT_OWNER
429 + "=?", new String
[] { value
, mAccount
.name
},
431 } catch (RemoteException e
) {
432 Log_OC
.e(TAG
, "Could not get file details: " + e
.getMessage());
439 private OCFile
createFileInstance(Cursor c
) {
442 file
= new OCFile(c
.getString(c
443 .getColumnIndex(ProviderTableMeta
.FILE_PATH
)));
444 file
.setFileId(c
.getLong(c
.getColumnIndex(ProviderTableMeta
._ID
)));
445 file
.setParentId(c
.getLong(c
446 .getColumnIndex(ProviderTableMeta
.FILE_PARENT
)));
447 file
.setMimetype(c
.getString(c
448 .getColumnIndex(ProviderTableMeta
.FILE_CONTENT_TYPE
)));
449 if (!file
.isDirectory()) {
450 file
.setStoragePath(c
.getString(c
451 .getColumnIndex(ProviderTableMeta
.FILE_STORAGE_PATH
)));
452 if (file
.getStoragePath() == null
) {
453 // 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
454 File f
= new File(FileStorageUtils
.getDefaultSavePathFor(mAccount
.name
, file
));
456 file
.setStoragePath(f
.getAbsolutePath());
457 file
.setLastSyncDateForData(f
.lastModified());
461 file
.setFileLength(c
.getLong(c
462 .getColumnIndex(ProviderTableMeta
.FILE_CONTENT_LENGTH
)));
463 file
.setCreationTimestamp(c
.getLong(c
464 .getColumnIndex(ProviderTableMeta
.FILE_CREATION
)));
465 file
.setModificationTimestamp(c
.getLong(c
466 .getColumnIndex(ProviderTableMeta
.FILE_MODIFIED
)));
467 file
.setModificationTimestampAtLastSyncForData(c
.getLong(c
468 .getColumnIndex(ProviderTableMeta
.FILE_MODIFIED_AT_LAST_SYNC_FOR_DATA
)));
469 file
.setLastSyncDateForProperties(c
.getLong(c
470 .getColumnIndex(ProviderTableMeta
.FILE_LAST_SYNC_DATE
)));
471 file
.setLastSyncDateForData(c
.getLong(c
.
472 getColumnIndex(ProviderTableMeta
.FILE_LAST_SYNC_DATE_FOR_DATA
)));
473 file
.setKeepInSync(c
.getInt(
474 c
.getColumnIndex(ProviderTableMeta
.FILE_KEEP_IN_SYNC
)) == 1 ? true
: false
);
480 public void removeFile(OCFile file
, boolean removeLocalCopy
) {
481 Uri file_uri
= Uri
.withAppendedPath(ProviderTableMeta
.CONTENT_URI_FILE
, ""+file
.getFileId());
482 if (getContentProvider() != null
) {
484 getContentProvider().delete(file_uri
,
485 ProviderTableMeta
.FILE_ACCOUNT_OWNER
+"=?",
486 new String
[]{mAccount
.name
});
487 } catch (RemoteException e
) {
491 getContentResolver().delete(file_uri
,
492 ProviderTableMeta
.FILE_ACCOUNT_OWNER
+"=?",
493 new String
[]{mAccount
.name
});
495 if (file
.isDown() && removeLocalCopy
) {
496 new File(file
.getStoragePath()).delete();
498 if (file
.isDirectory() && removeLocalCopy
) {
499 File f
= new File(FileStorageUtils
.getDefaultSavePathFor(mAccount
.name
, file
));
500 if (f
.exists() && f
.isDirectory() && (f
.list() == null
|| f
.list().length
== 0)) {
505 if (file
.getFileLength() > 0) {
506 updateSizesToTheRoot(file
.getParentId());
511 public void removeDirectory(OCFile dir
, boolean removeDBData
, boolean removeLocalContent
) {
512 // TODO consider possible failures
513 if (dir
!= null
&& dir
.isDirectory() && dir
.getFileId() != -1) {
514 Vector
<OCFile
> children
= getDirectoryContent(dir
);
515 if (children
.size() > 0) {
517 for (int i
=0; i
<children
.size(); i
++) {
518 child
= children
.get(i
);
519 if (child
.isDirectory()) {
520 removeDirectory(child
, removeDBData
, removeLocalContent
);
523 removeFile(child
, removeLocalContent
);
524 } else if (removeLocalContent
) {
525 if (child
.isDown()) {
526 new File(child
.getStoragePath()).delete();
533 removeFile(dir
, true
);
536 if (dir
.getFileLength() > 0) {
537 updateSizesToTheRoot(dir
.getParentId());
544 * Updates database for a folder that was moved to a different location.
546 * TODO explore better (faster) implementations
547 * TODO throw exceptions up !
550 public void moveDirectory(OCFile dir
, String newPath
) {
551 // TODO check newPath
553 if (dir
!= null
&& dir
.isDirectory() && dir
.fileExists() && !dir
.getFileName().equals(OCFile
.PATH_SEPARATOR
)) {
554 /// 1. get all the descendants of 'dir' in a single QUERY (including 'dir')
556 if (getContentProvider() != null
) {
558 c
= getContentProvider().query(ProviderTableMeta
.CONTENT_URI
,
560 ProviderTableMeta
.FILE_ACCOUNT_OWNER
+ "=? AND " + ProviderTableMeta
.FILE_PATH
+ " LIKE ? ",
561 new String
[] { mAccount
.name
, dir
.getRemotePath() + "%" }, ProviderTableMeta
.FILE_PATH
+ " ASC ");
562 } catch (RemoteException e
) {
563 Log_OC
.e(TAG
, e
.getMessage());
566 c
= getContentResolver().query(ProviderTableMeta
.CONTENT_URI
,
568 ProviderTableMeta
.FILE_ACCOUNT_OWNER
+ "=? AND " + ProviderTableMeta
.FILE_PATH
+ " LIKE ? ",
569 new String
[] { mAccount
.name
, dir
.getRemotePath() + "%" }, ProviderTableMeta
.FILE_PATH
+ " ASC ");
572 /// 2. prepare a batch of update operations to change all the descendants
573 ArrayList
<ContentProviderOperation
> operations
= new ArrayList
<ContentProviderOperation
>(c
.getCount());
574 int lengthOfOldPath
= dir
.getRemotePath().length();
575 String defaultSavePath
= FileStorageUtils
.getSavePath(mAccount
.name
);
576 int lengthOfOldStoragePath
= defaultSavePath
.length() + lengthOfOldPath
;
577 if (c
.moveToFirst()) {
579 ContentValues cv
= new ContentValues(); // don't take the constructor out of the loop and clear the object
580 OCFile child
= createFileInstance(c
);
581 cv
.put(ProviderTableMeta
.FILE_PATH
, newPath
+ child
.getRemotePath().substring(lengthOfOldPath
));
582 if (child
.getStoragePath() != null
&& child
.getStoragePath().startsWith(defaultSavePath
)) {
583 cv
.put(ProviderTableMeta
.FILE_STORAGE_PATH
, defaultSavePath
+ newPath
+ child
.getStoragePath().substring(lengthOfOldStoragePath
));
585 operations
.add(ContentProviderOperation
.newUpdate(ProviderTableMeta
.CONTENT_URI
).
587 withSelection( ProviderTableMeta
._ID
+ "=?",
588 new String
[] { String
.valueOf(child
.getFileId()) })
590 } while (c
.moveToNext());
594 /// 3. apply updates in batch
596 if (getContentResolver() != null
) {
597 getContentResolver().applyBatch(MainApp
.getAuthority(), operations
);
600 getContentProvider().applyBatch(operations
);
603 } catch (OperationApplicationException e
) {
604 Log_OC
.e(TAG
, "Fail to update descendants of " + dir
.getFileId() + " in database", e
);
606 } catch (RemoteException e
) {
607 Log_OC
.e(TAG
, "Fail to update desendants of " + dir
.getFileId() + " in database", e
);
614 public Vector
<OCFile
> getDirectoryImages(OCFile directory
) {
615 Vector
<OCFile
> ret
= new Vector
<OCFile
>();
616 if (directory
!= null
) {
617 // TODO better implementation, filtering in the access to database (if possible) instead of here
618 Vector
<OCFile
> tmp
= getDirectoryContent(directory
);
619 OCFile current
= null
;
620 for (int i
=0; i
<tmp
.size(); i
++) {
621 current
= tmp
.get(i
);
622 if (current
.isImage()) {
631 * Calculate and save the folderSize on DB
635 public void calculateFolderSize(long id
) {
638 Vector
<OCFile
> files
= getDirectoryContent(id
);
640 for (OCFile f
: files
)
642 folderSize
= folderSize
+ f
.getFileLength();
645 updateSize(id
, folderSize
);
649 * Update the size value of an OCFile in DB
651 private int updateSize(long id
, long size
) {
652 ContentValues cv
= new ContentValues();
653 cv
.put(ProviderTableMeta
.FILE_CONTENT_LENGTH
, size
);
655 if (getContentResolver() != null
) {
656 result
= getContentResolver().update(ProviderTableMeta
.CONTENT_URI
, cv
, ProviderTableMeta
._ID
+ "=?",
657 new String
[] { String
.valueOf(id
) });
660 result
= getContentProvider().update(ProviderTableMeta
.CONTENT_URI
, cv
, ProviderTableMeta
._ID
+ "=?",
661 new String
[] { String
.valueOf(id
) });
662 } catch (RemoteException e
) {
663 Log_OC
.e(TAG
,"Fail to update size column into database " + e
.getMessage());
670 * Update the size of a subtree of folder from a file to the root
671 * @param parentId: parent of the file
673 private void updateSizesToTheRoot(long parentId
) {
677 while (parentId
!= 0) {
679 // Update the size of the parent
680 calculateFolderSize(parentId
);
682 // search the next parent
683 file
= getFileById(parentId
);
684 parentId
= file
.getParentId();