Merge pull request #1088 from owncloud/updated_docs_about_target_of_PRs

[pub/Android/ownCloud.git] / src / com / owncloud / android / datamodel / OCFile.java

diff --git a/src/com/owncloud/android/datamodel/OCFile.java b/src/com/owncloud/android/datamodel/OCFile.java
index 82c341c..2c9c53b 100644 (file)
--- a/src/com/owncloud/android/datamodel/OCFile.java
+++ b/src/com/owncloud/android/datamodel/OCFile.java
@@ -1,6 +1,8 @@
-/* ownCloud Android client application
+/**
+ *   ownCloud Android client application
+ *

  *   Copyright (C) 2012  Bartek Przybylski
  *   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,
  *
  *   This program is free software: you can redistribute it and/or modify
  *   it under the terms of the GNU General Public License version 2,


@@ -18,15 +20,15 @@
 
 package com.owncloud.android.datamodel;
 
 
 package com.owncloud.android.datamodel;
 

-import java.io.File;
-
-import com.owncloud.android.utils.Log_OC;
-
-

 import android.os.Parcel;
 import android.os.Parcelable;
 import android.os.Parcel;
 import android.os.Parcelable;

-import android.webkit.MimeTypeMap;

 
 

+import com.owncloud.android.lib.common.utils.Log_OC;
+import com.owncloud.android.utils.FileStorageUtils;
+
+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>() {
 public class OCFile implements Parcelable, Comparable<OCFile> {
 
     public static final Parcelable.Creator<OCFile> CREATOR = new Parcelable.Creator<OCFile>() {


@@ -45,7 +47,7 @@ public class OCFile implements Parcelable, Comparable<OCFile> {
     public static final String ROOT_PATH = PATH_SEPARATOR;
 
     private static final String TAG = OCFile.class.getSimpleName();
     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 long mId;
     private long mParentId;
     private long mLength;


@@ -61,16 +63,23 @@ public class OCFile implements Parcelable, Comparable<OCFile> {
     private boolean mKeepInSync;
 
     private String mEtag;
     private boolean mKeepInSync;
 
     private String mEtag;

-    
+

     private boolean mShareByLink;
     private String mPublicLink;
 
     private boolean mShareByLink;
     private String mPublicLink;
 

+    private String mPermissions;
+    private String mRemoteId;
+
+    private boolean mNeedsUpdateThumbnail;
+
+    private boolean mIsDownloading;
+

 
     /**
      * Create new {@link OCFile} with given path.
 
     /**
      * 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'.
      * 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) {
      * @param path The remote path of the file.
      */
     public OCFile(String path) {


@@ -84,7 +93,7 @@ public class OCFile implements Parcelable, Comparable<OCFile> {
 
     /**
      * Reconstruct from parcel
 
     /**
      * Reconstruct from parcel

-     * 
+     *

      * @param source The source parcel
      */
     private OCFile(Parcel source) {
      * @param source The source parcel
      */
     private OCFile(Parcel source) {


@@ -104,6 +113,11 @@ public class OCFile implements Parcelable, Comparable<OCFile> {
         mEtag = source.readString();
         mShareByLink = source.readInt() == 1;
         mPublicLink = source.readString();
         mEtag = source.readString();
         mShareByLink = source.readInt() == 1;
         mPublicLink = source.readString();

+        mPermissions = source.readString();
+        mRemoteId = source.readString();
+        mNeedsUpdateThumbnail = source.readInt() == 0;
+        mIsDownloading = source.readInt() == 0;
+

     }
 
     @Override
     }
 
     @Override


@@ -124,11 +138,15 @@ public class OCFile implements Parcelable, Comparable<OCFile> {
         dest.writeString(mEtag);
         dest.writeInt(mShareByLink ? 1 : 0);
         dest.writeString(mPublicLink);
         dest.writeString(mEtag);
         dest.writeInt(mShareByLink ? 1 : 0);
         dest.writeString(mPublicLink);

+        dest.writeString(mPermissions);
+        dest.writeString(mRemoteId);
+        dest.writeInt(mNeedsUpdateThumbnail ? 1 : 0);
+        dest.writeInt(mIsDownloading ? 1 : 0);

     }
     }

-    
+

     /**
      * Gets the ID of the file
     /**
      * Gets the ID of the file

-     * 
+     *

      * @return the file ID
      */
     public long getFileId() {
      * @return the file ID
      */
     public long getFileId() {


@@ -137,7 +155,7 @@ public class OCFile implements Parcelable, Comparable<OCFile> {
 
     /**
      * Returns the remote path of the file on ownCloud
 
     /**
      * Returns the remote path of the file on ownCloud

-     * 
+     *

      * @return The remote path to the file
      */
     public String getRemotePath() {
      * @return The remote path to the file
      */
     public String getRemotePath() {


@@ -147,7 +165,7 @@ public class OCFile implements Parcelable, Comparable<OCFile> {
     /**
      * Can be used to check, whether or not this file exists in the database
      * already
     /**
      * 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() {
      * @return true, if the file exists in the database
      */
     public boolean fileExists() {


@@ -156,7 +174,7 @@ public class OCFile implements Parcelable, Comparable<OCFile> {
 
     /**
      * Use this to find out if this file is a folder.
 
     /**
      * Use this to find out if this file is a folder.

-     * 
+     *

      * @return true if it is a folder
      */
     public boolean isFolder() {
      * @return true if it is a folder
      */
     public boolean isFolder() {


@@ -165,7 +183,7 @@ public class OCFile implements Parcelable, Comparable<OCFile> {
 
     /**
      * Use this to check if this file is available locally
 
     /**
      * Use this to check if this file is available locally

-     * 
+     *

      * @return true if it is
      */
     public boolean isDown() {
      * @return true if it is
      */
     public boolean isDown() {


@@ -175,10 +193,10 @@ public class OCFile implements Parcelable, Comparable<OCFile> {
         }
         return false;
     }
         }
         return false;
     }

-    
+

     /**
      * The path, where the file is stored locally
     /**
      * The path, where the file is stored locally

-     * 
+     *

      * @return The local path to the file
      */
     public String getStoragePath() {
      * @return The local path to the file
      */
     public String getStoragePath() {


@@ -187,7 +205,7 @@ public class OCFile implements Parcelable, Comparable<OCFile> {
 
     /**
      * Can be used to set the path where the file is stored
 
     /**
      * Can be used to set the path where the file is stored

-     * 
+     *

      * @param storage_path to set
      */
     public void setStoragePath(String storage_path) {
      * @param storage_path to set
      */
     public void setStoragePath(String storage_path) {


@@ -196,7 +214,7 @@ public class OCFile implements Parcelable, Comparable<OCFile> {
 
     /**
      * Get a UNIX timestamp of the file creation time
 
     /**
      * Get a UNIX timestamp of the file creation time

-     * 
+     *

      * @return A UNIX timestamp of the time that file was created
      */
     public long getCreationTimestamp() {
      * @return A UNIX timestamp of the time that file was created
      */
     public long getCreationTimestamp() {


@@ -205,7 +223,7 @@ public class OCFile implements Parcelable, Comparable<OCFile> {
 
     /**
      * Set a UNIX timestamp of the time the file was created
 
     /**
      * Set a UNIX timestamp of the time the file was created

-     * 
+     *

      * @param creation_timestamp to set
      */
     public void setCreationTimestamp(long creation_timestamp) {
      * @param creation_timestamp to set
      */
     public void setCreationTimestamp(long creation_timestamp) {


@@ -215,8 +233,8 @@ public class OCFile implements Parcelable, Comparable<OCFile> {
     /**
      * Get a UNIX timestamp of the file modification time.
      *
     /**
      * 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;
      */
     public long getModificationTimestamp() {
         return mModifiedTimestamp;


@@ -224,22 +242,22 @@ public class OCFile implements Parcelable, Comparable<OCFile> {
 
     /**
      * Set a UNIX timestamp of the time the time the file was modified.
 
     /**
      * 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.
      * of this file.

-     * 
+     *

      * @param modification_timestamp to set
      */
     public void setModificationTimestamp(long modification_timestamp) {
         mModifiedTimestamp = modification_timestamp;
     }
 
      * @param modification_timestamp to set
      */
     public void setModificationTimestamp(long modification_timestamp) {
         mModifiedTimestamp = modification_timestamp;
     }
 

-    
+

     /**
      * Get a UNIX timestamp of the file modification time.
      *
     /**
      * 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;
      */
     public long getModificationTimestampAtLastSyncForData() {
         return mModifiedTimestampAtLastSyncForData;


@@ -247,39 +265,38 @@ public class OCFile implements Parcelable, Comparable<OCFile> {
 
     /**
      * Set a UNIX timestamp of the time the time the file was modified.
 
     /**
      * 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.
      * of this file.

-     * 
-     * @param modification_timestamp to set
+     *
+     * @param modificationTimestamp to set

      */
     public void setModificationTimestampAtLastSyncForData(long modificationTimestamp) {
         mModifiedTimestampAtLastSyncForData = modificationTimestamp;
     }
 
      */
     public void setModificationTimestampAtLastSyncForData(long modificationTimestamp) {
         mModifiedTimestampAtLastSyncForData = modificationTimestamp;
     }
 

-    
-    
+

     /**
      * Returns the filename and "/" for the root directory
     /**
      * 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();
     }
      * @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
     /**
      * 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)) {
             String parent = (new File(getRemotePath())).getParent();
             parent = (parent.endsWith(PATH_SEPARATOR)) ? parent : parent + PATH_SEPARATOR;
      */
     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)) {
             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;
             }
             if (isFolder()) {
                 mRemotePath += PATH_SEPARATOR;
             }


@@ -289,7 +306,7 @@ public class OCFile implements Parcelable, Comparable<OCFile> {
 
     /**
      * Can be used to get the Mimetype
 
     /**
      * Can be used to get the Mimetype

-     * 
+     *

      * @return the Mimetype as a String
      */
     public String getMimetype() {
      * @return the Mimetype as a String
      */
     public String getMimetype() {


@@ -299,10 +316,10 @@ public class OCFile implements Parcelable, Comparable<OCFile> {
     /**
      * Adds a file to this directory. If this file is not a directory, an
      * exception gets thrown.
     /**
      * 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
      * @param file to add
      * @throws IllegalStateException if you try to add a something and this is

-     *             not a directory
+     *                               not a directory

      */
     public void addFile(OCFile file) throws IllegalStateException {
         if (isFolder()) {
      */
     public void addFile(OCFile file) throws IllegalStateException {
         if (isFolder()) {


@@ -334,11 +351,15 @@ public class OCFile implements Parcelable, Comparable<OCFile> {
         mEtag = null;
         mShareByLink = false;
         mPublicLink = null;
         mEtag = null;
         mShareByLink = false;
         mPublicLink = null;

+        mPermissions = null;
+        mRemoteId = null;
+        mNeedsUpdateThumbnail = false;
+        mIsDownloading = false;

     }
 
     /**
      * Sets the ID of the file
     }
 
     /**
      * Sets the ID of the file

-     * 
+     *

      * @param file_id to set
      */
     public void setFileId(long file_id) {
      * @param file_id to set
      */
     public void setFileId(long file_id) {


@@ -347,7 +368,7 @@ public class OCFile implements Parcelable, Comparable<OCFile> {
 
     /**
      * Sets the Mime-Type of the
 
     /**
      * Sets the Mime-Type of the

-     * 
+     *

      * @param mimetype to set
      */
     public void setMimetype(String mimetype) {
      * @param mimetype to set
      */
     public void setMimetype(String mimetype) {


@@ -356,7 +377,7 @@ public class OCFile implements Parcelable, Comparable<OCFile> {
 
     /**
      * Sets the ID of the parent folder
 
     /**
      * Sets the ID of the parent folder

-     * 
+     *

      * @param parent_id to set
      */
     public void setParentId(long parent_id) {
      * @param parent_id to set
      */
     public void setParentId(long parent_id) {


@@ -365,7 +386,7 @@ public class OCFile implements Parcelable, Comparable<OCFile> {
 
     /**
      * Sets the file size in bytes
 
     /**
      * Sets the file size in bytes

-     * 
+     *

      * @param file_len to set
      */
     public void setFileLength(long file_len) {
      * @param file_len to set
      */
     public void setFileLength(long file_len) {


@@ -374,7 +395,7 @@ public class OCFile implements Parcelable, Comparable<OCFile> {
 
     /**
      * Returns the size of the file in bytes
 
     /**
      * Returns the size of the file in bytes

-     * 
+     *

      * @return The filesize in bytes
      */
     public long getFileLength() {
      * @return The filesize in bytes
      */
     public long getFileLength() {


@@ -383,7 +404,7 @@ public class OCFile implements Parcelable, Comparable<OCFile> {
 
     /**
      * Returns the ID of the parent Folder
 
     /**
      * Returns the ID of the parent Folder

-     * 
+     *

      * @return The ID
      */
     public long getParentId() {
      * @return The ID
      */
     public long getParentId() {


@@ -392,21 +413,29 @@ public class OCFile implements Parcelable, Comparable<OCFile> {
 
     /**
      * Check, if this file needs updating
 
     /**
      * Check, if this file needs updating

-     * 
+     *

      * @return
      */
     public boolean needsUpdatingWhileSaving() {
         return mNeedsUpdating;
     }
      * @return
      */
     public boolean needsUpdatingWhileSaving() {
         return mNeedsUpdating;
     }

-    
+
+    public boolean needsUpdateThumbnail() {
+        return mNeedsUpdateThumbnail;
+    }
+
+    public void setNeedsUpdateThumbnail(boolean needsUpdateThumbnail) {
+        this.mNeedsUpdateThumbnail = needsUpdateThumbnail;
+    }
+

     public long getLastSyncDateForProperties() {
         return mLastSyncDateForProperties;
     }
     public long getLastSyncDateForProperties() {
         return mLastSyncDateForProperties;
     }

-    
+

     public void setLastSyncDateForProperties(long lastSyncDate) {
         mLastSyncDateForProperties = lastSyncDate;
     }
     public void setLastSyncDateForProperties(long lastSyncDate) {
         mLastSyncDateForProperties = lastSyncDate;
     }

-    
+

     public long getLastSyncDateForData() {
         return mLastSyncDateForData;
     }
     public long getLastSyncDateForData() {
         return mLastSyncDateForData;
     }


@@ -418,14 +447,14 @@ public class OCFile implements Parcelable, Comparable<OCFile> {
     public void setKeepInSync(boolean keepInSync) {
         mKeepInSync = keepInSync;
     }
     public void setKeepInSync(boolean keepInSync) {
         mKeepInSync = keepInSync;
     }

-    
+

     public boolean keepInSync() {
         return mKeepInSync;
     }
     public boolean keepInSync() {
         return mKeepInSync;
     }

-    
+

     @Override
     public int describeContents() {
     @Override
     public int describeContents() {

-        return this.hashCode();
+        return ((Object) this).hashCode();

     }
 
     @Override
     }
 
     @Override


@@ -437,18 +466,18 @@ public class OCFile implements Parcelable, Comparable<OCFile> {
         } else if (another.isFolder()) {
             return 1;
         }
         } else if (another.isFolder()) {
             return 1;
         }

-        return getRemotePath().toLowerCase().compareTo(another.getRemotePath().toLowerCase());
+        return new AlphanumComparator().compare(this, another);

     }
 
     @Override
     public boolean equals(Object o) {
     }
 
     @Override
     public boolean equals(Object o) {

-        if(o instanceof OCFile){
+        if (o instanceof OCFile) {

             OCFile that = (OCFile) o;
             OCFile that = (OCFile) o;

-            if(that != null){
+            if (that != null) {

                 return this.mId == that.mId;
             }
         }
                 return this.mId == that.mId;
             }
         }

-        
+

         return false;
     }
 
         return false;
     }
 


@@ -466,8 +495,8 @@ public class OCFile implements Parcelable, Comparable<OCFile> {
     public void setEtag(String etag) {
         this.mEtag = etag;
     }
     public void setEtag(String etag) {
         this.mEtag = etag;
     }

-    
-    
+
+

     public boolean isShareByLink() {
         return mShareByLink;
     }
     public boolean isShareByLink() {
         return mShareByLink;
     }


@@ -492,30 +521,54 @@ public class OCFile implements Parcelable, Comparable<OCFile> {
         return 0;
     }
 
         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/"));
     }
 
     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/"));
     }
 
     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/")) ||
     public boolean isImage() {
         return ((mMimeType != null && mMimeType.startsWith("image/")) ||

-                 getMimeTypeFromName().startsWith("image/"));
-    }
-    
-    public String getMimeTypeFromName() {
-        String extension = "";
-        int pos = mRemotePath.lastIndexOf('.');
-        if (pos >= 0) {
-            extension = mRemotePath.substring(pos + 1);
-        }
-        String result = MimeTypeMap.getSingleton().getMimeTypeFromExtension(extension.toLowerCase());
-        return (result != null) ? result : "";
+                FileStorageUtils.getMimeTypeFromName(mRemotePath).startsWith("image/"));

     }
 
     }
 

+    public String getPermissions() {
+        return mPermissions;
+    }
+
+    public void setPermissions(String permissions) {
+        this.mPermissions = permissions;
+    }
+
+    public String getRemoteId() {
+        return mRemoteId;
+    }
+
+    public void setRemoteId(String remoteId) {
+        this.mRemoteId = remoteId;
+    }
+
+    public boolean isDownloading() {
+        return mIsDownloading;
+    }
+
+    public void setDownloading(boolean isDownloading) {
+        this.mIsDownloading = isDownloading;
+    }
+
+    public boolean isSynchronizing() {
+        // TODO real implementation
+        return false;
+    }

 }
 }