Merge pull request #453 from owncloud/improve_action_bar_pr_392_with_develop
[pub/Android/ownCloud.git] / src / com / owncloud / android / datamodel / OCFile.java
index f8208b7..82c341c 100644 (file)
@@ -1,10 +1,10 @@
 /* ownCloud Android client application
  *   Copyright (C) 2012  Bartek Przybylski
 /* ownCloud Android client application
  *   Copyright (C) 2012  Bartek Przybylski
+ *   Copyright (C) 2012-2013 ownCloud Inc.
  *
  *   This program is free software: you can redistribute it and/or modify
  *
  *   This program is free software: you can redistribute it and/or modify
- *   it under the terms of the GNU General Public License as published by
- *   the Free Software Foundation, either version 3 of the License, or
- *   (at your option) any later version.
+ *   it under the terms of the GNU General Public License version 2,
+ *   as published by the Free Software Foundation.
  *
  *   This program is distributed in the hope that it will be useful,
  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
  *
  *   This program is distributed in the hope that it will be useful,
  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
@@ -20,8 +20,12 @@ package com.owncloud.android.datamodel;
 
 import java.io.File;
 
 
 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;
 
 public class OCFile implements Parcelable, Comparable<OCFile> {
 
 
 public class OCFile implements Parcelable, Comparable<OCFile> {
 
@@ -38,19 +42,30 @@ public class OCFile implements Parcelable, Comparable<OCFile> {
     };
 
     public static final String PATH_SEPARATOR = "/";
     };
 
     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 long mCreationTimestamp;
     private long mModifiedTimestamp;
     
     private long mId;
     private long mParentId;
     private long mLength;
     private long mCreationTimestamp;
     private long mModifiedTimestamp;
+    private long mModifiedTimestampAtLastSyncForData;
     private String mRemotePath;
     private String mLocalPath;
     private String mMimeType;
     private boolean mNeedsUpdating;
     private String mRemotePath;
     private String mLocalPath;
     private String mMimeType;
     private boolean mNeedsUpdating;
-    private long mLastSyncDate;
+    private long mLastSyncDateForProperties;
+    private long mLastSyncDateForData;
     private boolean mKeepInSync;
 
     private boolean mKeepInSync;
 
+    private String mEtag;
+    
+    private boolean mShareByLink;
+    private String mPublicLink;
+
+
     /**
      * Create new {@link OCFile} with given path.
      * 
     /**
      * Create new {@link OCFile} with given path.
      * 
@@ -78,12 +93,17 @@ public class OCFile implements Parcelable, Comparable<OCFile> {
         mLength = source.readLong();
         mCreationTimestamp = source.readLong();
         mModifiedTimestamp = source.readLong();
         mLength = source.readLong();
         mCreationTimestamp = source.readLong();
         mModifiedTimestamp = source.readLong();
+        mModifiedTimestampAtLastSyncForData = source.readLong();
         mRemotePath = source.readString();
         mLocalPath = source.readString();
         mMimeType = source.readString();
         mNeedsUpdating = source.readInt() == 0;
         mKeepInSync = source.readInt() == 1;
         mRemotePath = source.readString();
         mLocalPath = source.readString();
         mMimeType = source.readString();
         mNeedsUpdating = source.readInt() == 0;
         mKeepInSync = source.readInt() == 1;
-        mLastSyncDate = source.readLong();
+        mLastSyncDateForProperties = source.readLong();
+        mLastSyncDateForData = source.readLong();
+        mEtag = source.readString();
+        mShareByLink = source.readInt() == 1;
+        mPublicLink = source.readString();
     }
 
     @Override
     }
 
     @Override
@@ -93,12 +113,17 @@ public class OCFile implements Parcelable, Comparable<OCFile> {
         dest.writeLong(mLength);
         dest.writeLong(mCreationTimestamp);
         dest.writeLong(mModifiedTimestamp);
         dest.writeLong(mLength);
         dest.writeLong(mCreationTimestamp);
         dest.writeLong(mModifiedTimestamp);
+        dest.writeLong(mModifiedTimestampAtLastSyncForData);
         dest.writeString(mRemotePath);
         dest.writeString(mLocalPath);
         dest.writeString(mMimeType);
         dest.writeInt(mNeedsUpdating ? 1 : 0);
         dest.writeInt(mKeepInSync ? 1 : 0);
         dest.writeString(mRemotePath);
         dest.writeString(mLocalPath);
         dest.writeString(mMimeType);
         dest.writeInt(mNeedsUpdating ? 1 : 0);
         dest.writeInt(mKeepInSync ? 1 : 0);
-        dest.writeLong(mLastSyncDate);
+        dest.writeLong(mLastSyncDateForProperties);
+        dest.writeLong(mLastSyncDateForData);
+        dest.writeString(mEtag);
+        dest.writeInt(mShareByLink ? 1 : 0);
+        dest.writeString(mPublicLink);
     }
     
     /**
     }
     
     /**
@@ -130,11 +155,11 @@ public class OCFile implements Parcelable, Comparable<OCFile> {
     }
 
     /**
     }
 
     /**
-     * Use this to find out if this file is a Directory
+     * Use this to find out if this file is a folder.
      * 
      * 
-     * @return true if it is a directory
+     * @return true if it is a folder
      */
      */
-    public boolean isDirectory() {
+    public boolean isFolder() {
         return mMimeType != null && mMimeType.equals("DIR");
     }
 
         return mMimeType != null && mMimeType.equals("DIR");
     }
 
@@ -188,9 +213,10 @@ public class OCFile implements Parcelable, Comparable<OCFile> {
     }
 
     /**
     }
 
     /**
-     * Get a UNIX timestamp of the file modification time
-     * 
-     * @return A UNIX timestamp of the 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. 
      */
     public long getModificationTimestamp() {
         return mModifiedTimestamp;
      */
     public long getModificationTimestamp() {
         return mModifiedTimestamp;
@@ -199,12 +225,40 @@ 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 
+     * 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.
+     *
+     * @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 
+     * of this file.
+     * 
+     * @param modification_timestamp to set
+     */
+    public void setModificationTimestampAtLastSyncForData(long modificationTimestamp) {
+        mModifiedTimestampAtLastSyncForData = modificationTimestamp;
+    }
+
+    
+    
     /**
      * Returns the filename and "/" for the root directory
      * 
     /**
      * Returns the filename and "/" for the root directory
      * 
@@ -212,7 +266,25 @@ public class OCFile implements Parcelable, Comparable<OCFile> {
      */
     public String getFileName() {
         File f = new File(getRemotePath());
      */
     public String getFileName() {
         File f = new File(getRemotePath());
-        return f.getName().length() == 0 ? "/" : f.getName();
+        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 
+     */
+    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;
+            if (isFolder()) {
+                mRemotePath += PATH_SEPARATOR;
+            }
+            Log_OC.d(TAG, "OCFile name changed to " + mRemotePath);
+        }
     }
 
     /**
     }
 
     /**
@@ -233,7 +305,7 @@ public class OCFile implements Parcelable, Comparable<OCFile> {
      *             not a directory
      */
     public void addFile(OCFile file) throws IllegalStateException {
      *             not a directory
      */
     public void addFile(OCFile file) throws IllegalStateException {
-        if (isDirectory()) {
+        if (isFolder()) {
             file.mParentId = mId;
             mNeedsUpdating = true;
             return;
             file.mParentId = mId;
             mNeedsUpdating = true;
             return;
@@ -254,9 +326,14 @@ public class OCFile implements Parcelable, Comparable<OCFile> {
         mLength = 0;
         mCreationTimestamp = 0;
         mModifiedTimestamp = 0;
         mLength = 0;
         mCreationTimestamp = 0;
         mModifiedTimestamp = 0;
-        mLastSyncDate = 0;
+        mModifiedTimestampAtLastSyncForData = 0;
+        mLastSyncDateForProperties = 0;
+        mLastSyncDateForData = 0;
         mKeepInSync = false;
         mNeedsUpdating = false;
         mKeepInSync = false;
         mNeedsUpdating = false;
+        mEtag = null;
+        mShareByLink = false;
+        mPublicLink = null;
     }
 
     /**
     }
 
     /**
@@ -322,12 +399,20 @@ public class OCFile implements Parcelable, Comparable<OCFile> {
         return mNeedsUpdating;
     }
     
         return mNeedsUpdating;
     }
     
-    public long getLastSyncDate() {
-        return mLastSyncDate;
+    public long getLastSyncDateForProperties() {
+        return mLastSyncDateForProperties;
     }
     
     }
     
-    public void setLastSyncDate(long lastSyncDate) {
-        mLastSyncDate = lastSyncDate;
+    public void setLastSyncDateForProperties(long lastSyncDate) {
+        mLastSyncDateForProperties = lastSyncDate;
+    }
+    
+    public long getLastSyncDateForData() {
+        return mLastSyncDateForData;
+    }
+
+    public void setLastSyncDateForData(long lastSyncDate) {
+        mLastSyncDateForData = lastSyncDate;
     }
 
     public void setKeepInSync(boolean keepInSync) {
     }
 
     public void setKeepInSync(boolean keepInSync) {
@@ -345,16 +430,17 @@ public class OCFile implements Parcelable, Comparable<OCFile> {
 
     @Override
     public int compareTo(OCFile another) {
 
     @Override
     public int compareTo(OCFile another) {
-        if (isDirectory() && another.isDirectory()) {
+        if (isFolder() && another.isFolder()) {
             return getRemotePath().toLowerCase().compareTo(another.getRemotePath().toLowerCase());
             return getRemotePath().toLowerCase().compareTo(another.getRemotePath().toLowerCase());
-        } else if (isDirectory()) {
+        } else if (isFolder()) {
             return -1;
             return -1;
-        } else if (another.isDirectory()) {
+        } else if (another.isFolder()) {
             return 1;
         }
         return getRemotePath().toLowerCase().compareTo(another.getRemotePath().toLowerCase());
     }
 
             return 1;
         }
         return getRemotePath().toLowerCase().compareTo(another.getRemotePath().toLowerCase());
     }
 
+    @Override
     public boolean equals(Object o) {
         if(o instanceof OCFile){
             OCFile that = (OCFile) o;
     public boolean equals(Object o) {
         if(o instanceof OCFile){
             OCFile that = (OCFile) o;
@@ -368,9 +454,68 @@ public class OCFile implements Parcelable, Comparable<OCFile> {
 
     @Override
     public String toString() {
 
     @Override
     public String toString() {
-        String asString = "[id=%s, name=%s, mime=%s, downloaded=%s, local=%s, remote=%s, parentId=%s, keepInSinc=%s]";
-        asString = String.format(asString, new Long(mId), getFileName(), mMimeType, isDown(), mLocalPath, mRemotePath, new Long(mParentId), new Boolean(mKeepInSync));
+        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);
         return asString;
     }
 
         return asString;
     }
 
+    public String getEtag() {
+        return mEtag;
+    }
+
+    public void setEtag(String etag) {
+        this.mEtag = etag;
+    }
+    
+    
+    public boolean isShareByLink() {
+        return mShareByLink;
+    }
+
+    public void setShareByLink(boolean shareByLink) {
+        this.mShareByLink = shareByLink;
+    }
+
+    public String getPublicLink() {
+        return mPublicLink;
+    }
+
+    public void setPublicLink(String publicLink) {
+        this.mPublicLink = publicLink;
+    }
+
+    public long getLocalModificationTimestamp() {
+        if (mLocalPath != null && mLocalPath.length() > 0) {
+            File f = new File(mLocalPath);
+            return f.lastModified();
+        }
+        return 0;
+    }
+
+    /** @return  'True' if the file contains audio */
+    public boolean isAudio() {
+        return (mMimeType != null && mMimeType.startsWith("audio/"));
+    }
+
+    /** @return  'True' if the file contains video */
+    public boolean isVideo() {
+        return (mMimeType != null && mMimeType.startsWith("video/"));
+    }
+
+    /** @return  'True' if the file contains an 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 : "";
+    }
+
 }
 }