-/* ownCloud Android client application
+/**
+ * ownCloud Android client application
+ *
+ * @author Bartek Przybylski
+ * @author David A. Velasco
* Copyright (C) 2012 Bartek Przybylski
- * Copyright (C) 2012-2013 ownCloud Inc.
+ * Copyright (C) 2015 ownCloud Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2,
package com.owncloud.android.datamodel;
-import java.io.File;
-
-import com.owncloud.android.MainApp;
-import com.owncloud.android.lib.common.utils.Log_OC;
-
-import third_parties.daveKoeller.AlphanumComparator;
-import android.content.Intent;
+import android.content.ContentResolver;
import android.net.Uri;
import android.os.Parcel;
import android.os.Parcelable;
import android.webkit.MimeTypeMap;
+import com.owncloud.android.lib.common.utils.Log_OC;
+
+import java.io.File;
+
+import third_parties.daveKoeller.AlphanumComparator;
public class OCFile implements Parcelable, Comparable<OCFile> {
public static final Parcelable.Creator<OCFile> CREATOR = new Parcelable.Creator<OCFile>() {
}
};
+ private final static String PERMISSION_SHARED_WITH_ME = "S"; // TODO move to better location
+
public static final String PATH_SEPARATOR = "/";
public static final String ROOT_PATH = PATH_SEPARATOR;
private static final String TAG = OCFile.class.getSimpleName();
-
+
private long mId;
private long mParentId;
private long mLength;
private boolean mNeedsUpdating;
private long mLastSyncDateForProperties;
private long mLastSyncDateForData;
- private boolean mKeepInSync;
+ private boolean mFavorite;
private String mEtag;
-
+
private boolean mShareByLink;
private String mPublicLink;
private boolean mNeedsUpdateThumbnail;
+ private boolean mIsDownloading;
+
+ private String mEtagInConflict; // Save file etag in the server, when there is a conflict. No conflict = null
+
+ private boolean mShareWithSharee;
+
+ /**
+ * URI to the local path of the file contents, if stored in the device; cached after first call
+ * to {@link #getStorageUri()}
+ */
+ private Uri mLocalUri;
+
/**
* Create new {@link OCFile} with given path.
- *
+ * <p/>
* The path received must be URL-decoded. Path separator must be OCFile.PATH_SEPARATOR, and it must be the first character in 'path'.
- *
+ *
* @param path The remote path of the file.
*/
public OCFile(String path) {
/**
* Reconstruct from parcel
- *
+ *
* @param source The source parcel
*/
private OCFile(Parcel source) {
mLocalPath = source.readString();
mMimeType = source.readString();
mNeedsUpdating = source.readInt() == 0;
- mKeepInSync = source.readInt() == 1;
+ mFavorite = source.readInt() == 1;
mLastSyncDateForProperties = source.readLong();
mLastSyncDateForData = source.readLong();
mEtag = source.readString();
mPublicLink = source.readString();
mPermissions = source.readString();
mRemoteId = source.readString();
- mNeedsUpdateThumbnail = source.readInt() == 0;
+ mNeedsUpdateThumbnail = source.readInt() == 1;
+ mIsDownloading = source.readInt() == 1;
+ mEtagInConflict = source.readString();
+ mShareWithSharee = source.readInt() == 1;
}
dest.writeString(mLocalPath);
dest.writeString(mMimeType);
dest.writeInt(mNeedsUpdating ? 1 : 0);
- dest.writeInt(mKeepInSync ? 1 : 0);
+ dest.writeInt(mFavorite ? 1 : 0);
dest.writeLong(mLastSyncDateForProperties);
dest.writeLong(mLastSyncDateForData);
dest.writeString(mEtag);
dest.writeString(mPermissions);
dest.writeString(mRemoteId);
dest.writeInt(mNeedsUpdateThumbnail ? 1 : 0);
+ dest.writeInt(mIsDownloading ? 1 : 0);
+ dest.writeString(mEtagInConflict);
+ dest.writeInt(mShareWithSharee ? 1 : 0);
}
-
+
/**
* Gets the ID of the file
- *
+ *
* @return the file ID
*/
public long getFileId() {
/**
* Returns the remote path of the file on ownCloud
- *
+ *
* @return The remote path to the file
*/
public String getRemotePath() {
/**
* Can be used to check, whether or not this file exists in the database
* already
- *
+ *
* @return true, if the file exists in the database
*/
public boolean fileExists() {
/**
* Use this to find out if this file is a folder.
- *
+ *
* @return true if it is a folder
*/
public boolean isFolder() {
/**
* Use this to check if this file is available locally
- *
+ *
* @return true if it is
*/
public boolean isDown() {
}
return false;
}
-
+
/**
* The path, where the file is stored locally
- *
+ *
* @return The local path to the file
*/
public String getStoragePath() {
}
/**
+ * The URI to the file contents, if stored locally
+ *
+ * @return A URI to the local copy of the file, or NULL if not stored in the device
+ */
+ public Uri getStorageUri() {
+ if (mLocalPath == null || mLocalPath.length() == 0) {
+ return null;
+ }
+ if (mLocalUri == null) {
+ Uri.Builder builder = new Uri.Builder();
+ builder.scheme(ContentResolver.SCHEME_FILE);
+ builder.path(mLocalPath);
+ mLocalUri = builder.build();
+ }
+ return mLocalUri;
+ }
+
+ /**
* Can be used to set the path where the file is stored
- *
+ *
* @param storage_path to set
*/
public void setStoragePath(String storage_path) {
mLocalPath = storage_path;
+ mLocalUri = null;
}
/**
* Get a UNIX timestamp of the file creation time
- *
+ *
* @return A UNIX timestamp of the time that file was created
*/
public long getCreationTimestamp() {
/**
* Set a UNIX timestamp of the time the file was created
- *
+ *
* @param creation_timestamp to set
*/
public void setCreationTimestamp(long creation_timestamp) {
/**
* Get a UNIX timestamp of the file modification time.
*
- * @return A UNIX timestamp of the modification time, corresponding to the value returned by the server
- * in the last synchronization of the properties of this file.
+ * @return A UNIX timestamp of the modification time, corresponding to the value returned by the server
+ * in the last synchronization of the properties of this file.
*/
public long getModificationTimestamp() {
return mModifiedTimestamp;
/**
* Set a UNIX timestamp of the time the time the file was modified.
- *
- * To update with the value returned by the server in every synchronization of the properties
+ * <p/>
+ * To update with the value returned by the server in every synchronization of the properties
* of this file.
- *
+ *
* @param modification_timestamp to set
*/
public void setModificationTimestamp(long modification_timestamp) {
mModifiedTimestamp = modification_timestamp;
}
-
+
/**
* Get a UNIX timestamp of the file modification time.
*
- * @return A UNIX timestamp of the modification time, corresponding to the value returned by the server
- * in the last synchronization of THE CONTENTS of this file.
+ * @return A UNIX timestamp of the modification time, corresponding to the value returned by the server
+ * in the last synchronization of THE CONTENTS of this file.
*/
public long getModificationTimestampAtLastSyncForData() {
return mModifiedTimestampAtLastSyncForData;
/**
* Set a UNIX timestamp of the time the time the file was modified.
- *
- * To update with the value returned by the server in every synchronization of THE CONTENTS
+ * <p/>
+ * To update with the value returned by the server in every synchronization of THE CONTENTS
* of this file.
- *
- * @param modification_timestamp to set
+ *
+ * @param modificationTimestamp to set
*/
public void setModificationTimestampAtLastSyncForData(long modificationTimestamp) {
mModifiedTimestampAtLastSyncForData = modificationTimestamp;
}
-
-
+
/**
* Returns the filename and "/" for the root directory
- *
+ *
* @return The name of the file
*/
public String getFileName() {
File f = new File(getRemotePath());
return f.getName().length() == 0 ? ROOT_PATH : f.getName();
}
-
+
/**
* Sets the name of the file
- *
- * Does nothing if the new name is null, empty or includes "/" ; or if the file is the root directory
+ * <p/>
+ * Does nothing if the new name is null, empty or includes "/" ; or if the file is the root
+ * directory
*/
public void setFileName(String name) {
Log_OC.d(TAG, "OCFile name changin from " + mRemotePath);
- if (name != null && name.length() > 0 && !name.contains(PATH_SEPARATOR) && !mRemotePath.equals(ROOT_PATH)) {
+ if (name != null && name.length() > 0 && !name.contains(PATH_SEPARATOR) &&
+ !mRemotePath.equals(ROOT_PATH)) {
String parent = (new File(getRemotePath())).getParent();
parent = (parent.endsWith(PATH_SEPARATOR)) ? parent : parent + PATH_SEPARATOR;
- mRemotePath = parent + name;
+ mRemotePath = parent + name;
if (isFolder()) {
mRemotePath += PATH_SEPARATOR;
}
Log_OC.d(TAG, "OCFile name changed to " + mRemotePath);
-
- // Notify MediaScanner about removed file
- Intent intent1 = new Intent(Intent.ACTION_MEDIA_SCANNER_SCAN_FILE);
- intent1.setData(Uri.fromFile(new File(this.getStoragePath())));
- MainApp.getAppContext().sendBroadcast(intent1);
-
- // Notify MediaScanner about new file
- Intent intent2 = new Intent(Intent.ACTION_MEDIA_SCANNER_SCAN_FILE);
- String folder = new File(this.getStoragePath()).getParent();
- Log_OC.d(TAG, "uri: " + folder+PATH_SEPARATOR+name);
- intent2.setData(Uri.fromFile(new File(folder+ PATH_SEPARATOR+name)));
- MainApp.getAppContext().sendBroadcast(intent2);
}
}
/**
* Can be used to get the Mimetype
- *
+ *
* @return the Mimetype as a String
*/
public String getMimetype() {
}
/**
- * Adds a file to this directory. If this file is not a directory, an
- * exception gets thrown.
- *
- * @param file to add
- * @throws IllegalStateException if you try to add a something and this is
- * not a directory
- */
- public void addFile(OCFile file) throws IllegalStateException {
- if (isFolder()) {
- file.mParentId = mId;
- mNeedsUpdating = true;
- return;
- }
- throw new IllegalStateException(
- "This is not a directory where you can add stuff to!");
- }
-
- /**
* Used internally. Reset all file properties
*/
private void resetData() {
mModifiedTimestampAtLastSyncForData = 0;
mLastSyncDateForProperties = 0;
mLastSyncDateForData = 0;
- mKeepInSync = false;
+ mFavorite = false;
mNeedsUpdating = false;
mEtag = null;
mShareByLink = false;
mPermissions = null;
mRemoteId = null;
mNeedsUpdateThumbnail = false;
+ mIsDownloading = false;
+ mEtagInConflict = null;
+ mShareWithSharee = false;
}
/**
* Sets the ID of the file
- *
+ *
* @param file_id to set
*/
public void setFileId(long file_id) {
/**
* Sets the Mime-Type of the
- *
+ *
* @param mimetype to set
*/
public void setMimetype(String mimetype) {
/**
* Sets the ID of the parent folder
- *
+ *
* @param parent_id to set
*/
public void setParentId(long parent_id) {
/**
* Sets the file size in bytes
- *
+ *
* @param file_len to set
*/
public void setFileLength(long file_len) {
/**
* Returns the size of the file in bytes
- *
+ *
* @return The filesize in bytes
*/
public long getFileLength() {
/**
* Returns the ID of the parent Folder
- *
+ *
* @return The ID
*/
public long getParentId() {
/**
* Check, if this file needs updating
- *
+ *
* @return
*/
public boolean needsUpdatingWhileSaving() {
return mNeedsUpdating;
}
-
+
public boolean needsUpdateThumbnail() {
return mNeedsUpdateThumbnail;
}
public long getLastSyncDateForProperties() {
return mLastSyncDateForProperties;
}
-
+
public void setLastSyncDateForProperties(long lastSyncDate) {
mLastSyncDateForProperties = lastSyncDate;
}
-
+
public long getLastSyncDateForData() {
return mLastSyncDateForData;
}
mLastSyncDateForData = lastSyncDate;
}
- public void setKeepInSync(boolean keepInSync) {
- mKeepInSync = keepInSync;
+ public void setFavorite(boolean favorite) {
+ mFavorite = favorite;
}
-
- public boolean keepInSync() {
- return mKeepInSync;
+
+ public boolean isFavorite() {
+ return mFavorite;
}
-
+
@Override
public int describeContents() {
- return this.hashCode();
+ return super.hashCode();
}
@Override
@Override
public boolean equals(Object o) {
- if(o instanceof OCFile){
+ if (o instanceof OCFile) {
OCFile that = (OCFile) o;
- if(that != null){
+ if (that != null) {
return this.mId == that.mId;
}
}
-
+
return false;
}
@Override
public String toString() {
- String asString = "[id=%s, name=%s, mime=%s, downloaded=%s, local=%s, remote=%s, parentId=%s, keepInSync=%s etag=%s]";
- asString = String.format(asString, Long.valueOf(mId), getFileName(), mMimeType, isDown(), mLocalPath, mRemotePath, Long.valueOf(mParentId), Boolean.valueOf(mKeepInSync), mEtag);
+ String asString = "[id=%s, name=%s, mime=%s, downloaded=%s, local=%s, remote=%s, " +
+ "parentId=%s, favorite=%s etag=%s]";
+ asString = String.format(asString, Long.valueOf(mId), getFileName(), mMimeType, isDown(),
+ mLocalPath, mRemotePath, Long.valueOf(mParentId), Boolean.valueOf(mFavorite),
+ mEtag);
return asString;
}
}
public void setEtag(String etag) {
- this.mEtag = etag;
+ this.mEtag = (etag != null ? etag : "");
}
-
-
- public boolean isShareByLink() {
+
+
+ public boolean isSharedViaLink() {
return mShareByLink;
}
- public void setShareByLink(boolean shareByLink) {
+ public void setShareViaLink(boolean shareByLink) {
this.mShareByLink = shareByLink;
}
return 0;
}
- /** @return 'True' if the file contains audio */
+ /**
+ * @return 'True' if the file contains audio
+ */
public boolean isAudio() {
return (mMimeType != null && mMimeType.startsWith("audio/"));
}
- /** @return 'True' if the file contains video */
+ /**
+ * @return 'True' if the file contains video
+ */
public boolean isVideo() {
return (mMimeType != null && mMimeType.startsWith("video/"));
}
- /** @return 'True' if the file contains an image */
+ /**
+ * @return 'True' if the file contains an image
+ */
public boolean isImage() {
return ((mMimeType != null && mMimeType.startsWith("image/")) ||
- getMimeTypeFromName().startsWith("image/"));
+ getMimeTypeFromName().startsWith("image/"));
+ }
+
+ /**
+ * @return 'True' if the file is simple text (e.g. not application-dependent, like .doc or .docx)
+ */
+ public boolean isText() {
+ return ((mMimeType != null && mMimeType.startsWith("text/")) ||
+ getMimeTypeFromName().startsWith("text/"));
}
-
+
public String getMimeTypeFromName() {
String extension = "";
int pos = mRemotePath.lastIndexOf('.');
if (pos >= 0) {
extension = mRemotePath.substring(pos + 1);
}
- String result = MimeTypeMap.getSingleton().getMimeTypeFromExtension(extension.toLowerCase());
+ String result = MimeTypeMap.getSingleton().
+ getMimeTypeFromExtension(extension.toLowerCase());
return (result != null) ? result : "";
}
+ /**
+ * @return 'True' if the file is hidden
+ */
+ public boolean isHidden() {
+ return getFileName().startsWith(".");
+ }
+
public String getPermissions() {
return mPermissions;
}
this.mRemoteId = remoteId;
}
+ public boolean isDownloading() {
+ return mIsDownloading;
+ }
+
+ public void setDownloading(boolean isDownloading) {
+ this.mIsDownloading = isDownloading;
+ }
+
+ public String getEtagInConflict() {
+ return mEtagInConflict;
+ }
+
+ public void setEtagInConflict(String etagInConflict) {
+ mEtagInConflict = etagInConflict;
+ }
+
+ public boolean isSharedWithSharee() {
+ return mShareWithSharee;
+ }
+
+ public void setShareWithSharee(boolean shareWithSharee) {
+ this.mShareWithSharee = shareWithSharee;
+ }
+
+ public boolean isSharedWithMe() {
+ String permissions = getPermissions();
+ return (permissions != null && permissions.contains(PERMISSION_SHARED_WITH_ME));
+ }
}
projects / pub / Android / ownCloud.git / blobdiff