Fixed: Rotating screen after viewing a file would return you to the
[pub/Android/ownCloud.git] / src / eu / alefzero / owncloud / datamodel / OCFile.java
index 46f5fa1..6861933 100644 (file)
 package eu.alefzero.owncloud.datamodel;
 
 import java.io.File;
-import java.util.Vector;
-
-import android.accounts.Account;
-import android.content.ContentProviderClient;
-import android.content.ContentResolver;
-import android.content.ContentValues;
-import android.database.Cursor;
-import android.net.Uri;
-import android.os.RemoteException;
-import android.util.Log;
-import eu.alefzero.owncloud.db.ProviderMeta.ProviderTableMeta;
-
-public class OCFile {
-       private static String TAG = "OCFile";
-
-       private long id_;
-       private long parent_id_;
-       private long length_;
-       private long creation_timestamp_;
-       private long modified_timestamp_;
-       private String path_;
-       private String storage_path_;
-       private String mimetype_;
-
-       private ContentResolver contentResolver_;
-       private ContentProviderClient providerClient_;
-       private Account account_;
-       
-       private OCFile(ContentProviderClient providerClient, Account account) {
-               account_ = account;
-               providerClient_ = providerClient;
-               resetData();
-       }
-
-       private OCFile(ContentResolver contentResolver, Account account) {
-               account_ = account;
-               contentResolver_ = contentResolver;
-               resetData();
-       }
-       
-       /**
-        * Query the database for a {@link OCFile} belonging to a given account 
-        * and id.
-        * 
-        * @param resolver The {@link ContentResolver} to use
-        * @param account The {@link Account} the {@link OCFile} belongs to
-        * @param id The ID the file has in the database
-        */
-       public OCFile(ContentResolver resolver, Account account, long id) {
-               contentResolver_ = resolver;
-               account_ = account;
-               Cursor c = contentResolver_.query(ProviderTableMeta.CONTENT_URI_FILE,
-                               null, ProviderTableMeta.FILE_ACCOUNT_OWNER + "=? AND "
-                                               + ProviderTableMeta._ID + "=?", new String[] {
-                                               account_.name, String.valueOf(id) }, null);
-               if (c.moveToFirst())
-                       setFileData(c);
-       }
-
-       /**
-        * Query the database for a {@link OCFile} belonging to a given account
-        * and that matches remote path
-        * 
-        * @param contentResolver The {@link ContentResolver} to use
-        * @param account The {@link Account} the {@link OCFile} belongs to
-        * @param path The remote path of the file
-        */
-       public OCFile(ContentResolver contentResolver, Account account, String path) {
-               contentResolver_ = contentResolver;
-               account_ = account;
-
-               Cursor c = contentResolver_.query(ProviderTableMeta.CONTENT_URI_FILE,
-                               null, ProviderTableMeta.FILE_ACCOUNT_OWNER + "=? AND "
-                                               + ProviderTableMeta.FILE_PATH + "=?", new String[] {
-                                               account_.name, path }, null);
-               if (c.moveToFirst()) {
-                       setFileData(c);
-                       if (path_ != null)
-                               path_ = path;
-               }
-       }
-       
-       public OCFile(ContentProviderClient cp, Account account, String path) {
-               providerClient_ = cp;
-               account_ = account;
-
-               try {
-                       Cursor c = providerClient_.query(ProviderTableMeta.CONTENT_URI_FILE, null,
-                                       ProviderTableMeta.FILE_ACCOUNT_OWNER + "=? AND "
-                                                       + ProviderTableMeta.FILE_PATH + "=?", new String[] {
-                                                       account_.name, path }, null);
-                       if (c.moveToFirst()) {
-                               setFileData(c);
-                               if (path_ != null)
-                                       path_ = path;
-                       }
-               } catch (RemoteException e) {
-                       Log.d(TAG, e.getMessage());
-               }
-       }
-
-       /**
-        * Creates a new {@link OCFile}
-        *  
-        * @param providerClient The {@link ContentProviderClient} to use
-        * @param account The {@link Account} that this file belongs to
-        * @param path The remote path
-        * @param length The file size in bytes 
-        * @param creation_timestamp The UNIX timestamp of the creation date
-        * @param modified_timestamp The UNIX timestamp of the modification date
-        * @param mimetype The mimetype to set
-        * @param parent_id The parent folder of that file
-        * @return A new instance of {@link OCFile}
-        */
-       public static OCFile createNewFile(ContentProviderClient providerClient,
-                       Account account, String path, long length, long creation_timestamp,
-                       long modified_timestamp, String mimetype, long parent_id) {
-               OCFile new_file = new OCFile(providerClient, account);
-
-               try {
-                       Cursor c = new_file.providerClient_.query(ProviderTableMeta.CONTENT_URI_FILE,
-                                       null, ProviderTableMeta.FILE_ACCOUNT_OWNER + "=? AND "
-                                                       + ProviderTableMeta.FILE_PATH + "=?", new String[] {
-                                                       new_file.account_.name, path }, null);
-                       if (c.moveToFirst())
-                               new_file.setFileData(c);
-                       c.close();
-               } catch (RemoteException e) {
-                       Log.e(TAG, e.getMessage());
-               }
-
-               new_file.path_ = path;
-               new_file.length_ = length;
-               new_file.creation_timestamp_ = creation_timestamp;
-               new_file.modified_timestamp_ = modified_timestamp;
-               new_file.mimetype_ = mimetype;
-               new_file.parent_id_ = parent_id;
-
-               return new_file;
-       }
-
-       /**
-        * Creates a new {@link OCFile}
-        * 
-        * @param contentResolver The {@link ContentResolver} to use
-        * @param account The {@link Account} that this file belongs to
-        * @param path The remote path
-        * @param length The file size in bytes
-        * @param creation_timestamp The UNIX timestamp of the creation date
-        * @param modified_timestamp The UNIX timestamp of the modification date 
-        * @param mimetype The mimetype to set
-        * @param parent_id The parent folder of that file
-        * @return A new instance of {@link OCFile}
-        */
-       public static OCFile createNewFile(ContentResolver contentResolver,
-                       Account account, String path, int length, int creation_timestamp,
-                       int modified_timestamp, String mimetype, long parent_id) {
-               OCFile new_file = new OCFile(contentResolver, account);
-               Cursor c = new_file.contentResolver_.query(
-                               ProviderTableMeta.CONTENT_URI_FILE, null,
-                               ProviderTableMeta.FILE_ACCOUNT_OWNER + "=? AND "
-                                               + ProviderTableMeta.FILE_PATH + "=?", new String[] {
-                                               new_file.account_.name, path }, null);
-               if (c.moveToFirst())
-                       new_file.setFileData(c);
-               c.close();
-
-               new_file.path_ = path;
-               new_file.length_ = length;
-               new_file.creation_timestamp_ = creation_timestamp;
-               new_file.modified_timestamp_ = modified_timestamp;
-               new_file.mimetype_ = mimetype;
-               new_file.parent_id_ = parent_id;
-
-               return new_file;
-       }
-
-
-       /**
-        * Gets the ID of the file
-        * 
-        * @return the file ID
-        */
-       public long getFileId() {
-               return id_;
-       }
-
-       /**
-        * Returns the path of the file
-        * 
-        * @return The path
-        */
-       public String getPath() {
-               return path_;
-       }
-
-       /**
-        * 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 id_ != -1;
-       }
-
-       /**
-        * Use this to find out if this file is a Directory
-        * 
-        * @return true if it is a directory
-        */
-       public boolean isDirectory() {
-               return mimetype_ != null && mimetype_.equals("DIR");
-       }
-
-       /**
-        * Use this to check if this file is available locally
-        * 
-        * @return true if it is
-        */
-       public boolean isDownloaded() {
-               return storage_path_ != null;
-       }
-
-       /**
-        * The path, where the file is stored locally
-        * 
-        * @return The local path to the file
-        */
-       public String getStoragePath() {
-               return storage_path_;
-       }
-
-       /**
-        * Can be used to set the path where the file is stored
-        * 
-        * @param storage_path
-        *            to set
-        */
-       public void setStoragePath(String storage_path) {
-               storage_path_ = storage_path;
-       }
-
-       /**
-        * Get a UNIX timestamp of the file creation time
-        * 
-        * @return A UNIX timestamp of the time that file was created
-        */
-       public long getCreationTimestamp() {
-               return creation_timestamp_;
-       }
-
-       /**
-        * Set a UNIX timestamp of the time the file was created
-        * 
-        * @param creation_timestamp
-        *            to set
-        */
-       public void setCreationTimestamp(long creation_timestamp) {
-               creation_timestamp_ = creation_timestamp;
-       }
-
-       /**
-        * Get a UNIX timestamp of the file modification time
-        * 
-        * @return A UNIX timestamp of the modification time
-        */
-       public long getModificationTimestamp() {
-               return modified_timestamp_;
-       }
-
-       /**
-        * Set a UNIX timestamp of the time the time the file was modified.
-        * 
-        * @param modification_timestamp
-        *            to set
-        */
-       public void setModificationTimestamp(long modification_timestamp) {
-               modified_timestamp_ = modification_timestamp;
-       }
-
-       /**
-        * Returns the filename and "/" for the root directory
-        * 
-        * @return The name of the file
-        */
-       public String getFileName() {
-               if (path_ != null) {
-                       File f = new File(path_);
-                       return f.getName().equals("") ? "/" : f.getName();
-               }
-               return null;
-       }
-
-       /**
-        * Can be used to get the Mimetype
-        * 
-        * @return the Mimetype as a String
-        */
-       public String getMimetype() {
-               return mimetype_;
-       }
-
-       /**
-        * Instruct the file to save itself to the database
-        */
-       public void save() {
-               ContentValues cv = new ContentValues();
-               cv.put(ProviderTableMeta.FILE_MODIFIED, modified_timestamp_);
-               cv.put(ProviderTableMeta.FILE_CREATION, creation_timestamp_);
-               cv.put(ProviderTableMeta.FILE_CONTENT_LENGTH, length_);
-               cv.put(ProviderTableMeta.FILE_CONTENT_TYPE, mimetype_);
-               cv.put(ProviderTableMeta.FILE_NAME, getFileName());
-               if (parent_id_ != 0)
-                       cv.put(ProviderTableMeta.FILE_PARENT, parent_id_);
-               cv.put(ProviderTableMeta.FILE_PATH, path_);
-               cv.put(ProviderTableMeta.FILE_STORAGE_PATH, storage_path_);
-               cv.put(ProviderTableMeta.FILE_ACCOUNT_OWNER, account_.name);
-
-               if (fileExists()) {
-                       if (providerClient_ != null) {
-                               try {
-                                       providerClient_.update(ProviderTableMeta.CONTENT_URI, cv,
-                                                       ProviderTableMeta._ID + "=?",
-                                                       new String[] { String.valueOf(id_) });
-                               } catch (RemoteException e) {
-                                       Log.e(TAG, e.getMessage());
-                                       return;
-                               }
-                       } else {
-                               contentResolver_.update(ProviderTableMeta.CONTENT_URI, cv,
-                                               ProviderTableMeta._ID + "=?",
-                                               new String[] { String.valueOf(id_) });
-                       }
-               } else {
-                       Uri new_entry = null;
-                       if (providerClient_ != null) {
-                               try {
-                                       new_entry = providerClient_.insert(ProviderTableMeta.CONTENT_URI_FILE,
-                                                       cv);
-                               } catch (RemoteException e) {
-                                       Log.e(TAG, e.getMessage());
-                                       id_ = -1;
-                                       return;
-                               }
-                       } else {
-                               new_entry = contentResolver_.insert(
-                                               ProviderTableMeta.CONTENT_URI_FILE, cv);
-                       }
-                       try {
-                               String p = new_entry.getEncodedPath();
-                               id_ = Integer.parseInt(p.substring(p.lastIndexOf('/') + 1));
-                       } catch (NumberFormatException e) {
-                               Log.e(TAG,
-                                               "Can't retrieve file id from uri: "
-                                                               + new_entry.toString() + ", reason: "
-                                                               + e.getMessage());
-                               id_ = -1;
-                       }
-               }
-       }
-
-       /**
-        * List the directory content
-        * 
-        * @return The directory content or null, if the file is not a directory
-        */
-       public Vector<OCFile> getDirectoryContent() {
-               if (isDirectory() && id_ != -1) {
-                       Vector<OCFile> ret = new Vector<OCFile>();
-
-                       Uri req_uri = Uri.withAppendedPath(
-                                       ProviderTableMeta.CONTENT_URI_DIR, String.valueOf(id_));
-                       Cursor c = null;
-                       if (providerClient_ != null) {
-                               try {
-                                       c = providerClient_.query(req_uri, null, null, null, null);
-                               } catch (RemoteException e) {
-                                       Log.e(TAG, e.getMessage());
-                                       return ret;
-                               }
-                       } else {
-                               c = contentResolver_.query(req_uri, null, null, null, null);
-                       }
-
-                       if (c.moveToFirst())
-                               do {
-                                       OCFile child = new OCFile(providerClient_, account_);
-                                       child.setFileData(c);
-                                       ret.add(child);
-                               } while (c.moveToNext());
-
-                       c.close();
-                       return ret;
-               }
-               return null;
-       }
-
-       /**
-        * 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 (isDirectory()) {
-                       file.parent_id_ = id_;
-                       file.save();
-                       return;
-               }
-               throw new IllegalStateException(
-                               "This is not a directory where you can add stuff to!");
-       }
-
-       /**
-        * Used internally. Reset all file properties
-        */
-       private void resetData() {
-               id_ = -1;
-               path_ = null;
-               parent_id_ = 0;
-               storage_path_ = null;
-               mimetype_ = null;
-               length_ = 0;
-               creation_timestamp_ = 0;
-               modified_timestamp_ = 0;
-       }
-
-       /**
-        * Used internally. Set properties based on the information in a {@link android.database.Cursor}
-        * @param c the Cursor containing the information
-        */
-       private void setFileData(Cursor c) {
-               resetData();
-               if (c != null) {
-                       id_ = c.getLong(c.getColumnIndex(ProviderTableMeta._ID));
-                       path_ = c.getString(c.getColumnIndex(ProviderTableMeta.FILE_PATH));
-                       parent_id_ = c.getLong(c
-                                       .getColumnIndex(ProviderTableMeta.FILE_PARENT));
-                       storage_path_ = c.getString(c
-                                       .getColumnIndex(ProviderTableMeta.FILE_STORAGE_PATH));
-                       mimetype_ = c.getString(c
-                                       .getColumnIndex(ProviderTableMeta.FILE_CONTENT_TYPE));
-                       length_ = c.getLong(c
-                                       .getColumnIndex(ProviderTableMeta.FILE_CONTENT_LENGTH));
-                       creation_timestamp_ = c.getLong(c
-                                       .getColumnIndex(ProviderTableMeta.FILE_CREATION));
-                       modified_timestamp_ = c.getLong(c
-                                       .getColumnIndex(ProviderTableMeta.FILE_MODIFIED));
-               }
-       }
+
+import android.os.Parcel;
+import android.os.Parcelable;
+
+public class OCFile implements Parcelable, Comparable<OCFile> {
+
+    public static final Parcelable.Creator<OCFile> CREATOR = new Parcelable.Creator<OCFile>() {
+        @Override
+        public OCFile createFromParcel(Parcel source) {
+            return new OCFile(source);
+        }
+
+        @Override
+        public OCFile[] newArray(int size) {
+            return new OCFile[size];
+        }
+    };
+
+    private long mId;
+    private long mParentId;
+    private long mLength;
+    private long mCreationTimestamp;
+    private long mModifiedTimestamp;
+    private String mRemotePath;
+    private String mLocalPath;
+    private String mMimeType;
+    private boolean mNeedsUpdating;
+    private long mLastSyncDate;
+
+    /**
+     * Create new {@link OCFile} with given path
+     * 
+     * @param path The remote path of the file
+     */
+    public OCFile(String path) {
+        resetData();
+        mNeedsUpdating = false;
+        mRemotePath = path;
+    }
+
+    /**
+     * Reconstruct from parcel
+     * 
+     * @param source The source parcel
+     */
+    private OCFile(Parcel source) {
+        mId = source.readLong();
+        mParentId = source.readLong();
+        mLength = source.readLong();
+        mCreationTimestamp = source.readLong();
+        mModifiedTimestamp = source.readLong();
+        mRemotePath = source.readString();
+        mLocalPath = source.readString();
+        mMimeType = source.readString();
+        mNeedsUpdating = source.readInt() == 0;
+    }
+
+    /**
+     * Gets the ID of the file
+     * 
+     * @return the file ID
+     */
+    public long getFileId() {
+        return mId;
+    }
+
+    /**
+     * Returns the remote path of the file on ownCloud
+     * 
+     * @return The remote path to the file
+     */
+    public String getRemotePath() {
+        return mRemotePath;
+    }
+
+    /**
+     * 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 mId != -1;
+    }
+
+    /**
+     * Use this to find out if this file is a Directory
+     * 
+     * @return true if it is a directory
+     */
+    public boolean isDirectory() {
+        return mMimeType != null && mMimeType.equals("DIR");
+    }
+
+    /**
+     * Use this to check if this file is available locally
+     * 
+     * @return true if it is
+     */
+    public boolean isDownloaded() {
+        return mLocalPath != null && !mLocalPath.equals("");
+    }
+
+    /**
+     * The path, where the file is stored locally
+     * 
+     * @return The local path to the file
+     */
+    public String getStoragePath() {
+        return mLocalPath;
+    }
+
+    /**
+     * 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;
+    }
+
+    /**
+     * Get a UNIX timestamp of the file creation time
+     * 
+     * @return A UNIX timestamp of the time that file was created
+     */
+    public long getCreationTimestamp() {
+        return mCreationTimestamp;
+    }
+
+    /**
+     * Set a UNIX timestamp of the time the file was created
+     * 
+     * @param creation_timestamp to set
+     */
+    public void setCreationTimestamp(long creation_timestamp) {
+        mCreationTimestamp = creation_timestamp;
+    }
+
+    /**
+     * Get a UNIX timestamp of the file modification time
+     * 
+     * @return A UNIX timestamp of the modification time
+     */
+    public long getModificationTimestamp() {
+        return mModifiedTimestamp;
+    }
+
+    /**
+     * Set a UNIX timestamp of the time the time the file was modified.
+     * 
+     * @param modification_timestamp to set
+     */
+    public void setModificationTimestamp(long modification_timestamp) {
+        mModifiedTimestamp = modification_timestamp;
+    }
+
+    /**
+     * Returns the filename and "/" for the root directory
+     * 
+     * @return The name of the file
+     */
+    public String getFileName() {
+        if (mRemotePath != null) {
+            File f = new File(mRemotePath);
+            return f.getName().equals("") ? "/" : f.getName();
+        }
+        return null;
+    }
+
+    /**
+     * Can be used to get the Mimetype
+     * 
+     * @return the Mimetype as a String
+     */
+    public String getMimetype() {
+        return mMimeType;
+    }
+
+    /**
+     * 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 (isDirectory()) {
+            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() {
+        mId = -1;
+        mRemotePath = null;
+        mParentId = 0;
+        mLocalPath = null;
+        mMimeType = null;
+        mLength = 0;
+        mCreationTimestamp = 0;
+        mModifiedTimestamp = 0;
+        mLastSyncDate = 0;
+    }
+
+    /**
+     * Sets the ID of the file
+     * 
+     * @param file_id to set
+     */
+    public void setFileId(long file_id) {
+        mId = file_id;
+    }
+
+    /**
+     * Sets the Mime-Type of the
+     * 
+     * @param mimetype to set
+     */
+    public void setMimetype(String mimetype) {
+        mMimeType = mimetype;
+    }
+
+    /**
+     * Sets the ID of the parent folder
+     * 
+     * @param parent_id to set
+     */
+    public void setParentId(long parent_id) {
+        mParentId = parent_id;
+    }
+
+    /**
+     * Sets the file size in bytes
+     * 
+     * @param file_len to set
+     */
+    public void setFileLength(long file_len) {
+        mLength = file_len;
+    }
+
+    /**
+     * Returns the size of the file in bytes
+     * 
+     * @return The filesize in bytes
+     */
+    public long getFileLength() {
+        return mLength;
+    }
+
+    /**
+     * Returns the ID of the parent Folder
+     * 
+     * @return The ID
+     */
+    public long getParentId() {
+        return mParentId;
+    }
+
+    /**
+     * Check, if this file needs updating
+     * 
+     * @return
+     */
+    public boolean needsUpdatingWhileSaving() {
+        return mNeedsUpdating;
+    }
+    
+    public long getLastSyncDate() {
+        return mLastSyncDate;
+    }
+    
+    public void setLastSyncDate(long lastSyncDate) {
+        mLastSyncDate = lastSyncDate;
+    }
+
+    @Override
+    public int describeContents() {
+        return this.hashCode();
+    }
+
+    @Override
+    public void writeToParcel(Parcel dest, int flags) {
+        dest.writeLong(mId);
+        dest.writeLong(mParentId);
+        dest.writeLong(mLength);
+        dest.writeLong(mCreationTimestamp);
+        dest.writeLong(mModifiedTimestamp);
+        dest.writeString(mRemotePath);
+        dest.writeString(mLocalPath);
+        dest.writeString(mMimeType);
+        dest.writeInt(mNeedsUpdating ? 1 : 0);
+        dest.writeLong(mLastSyncDate);
+    }
+
+    @Override
+    public int compareTo(OCFile another) {
+        if (isDirectory() && another.isDirectory()) {
+            return getFileName().toLowerCase().compareTo(another.getFileName().toLowerCase());
+        } else if (isDirectory()) {
+            return -1;
+        } else if (another.isDirectory()) {
+            return 1;
+        }
+        return getFileName().toLowerCase().compareTo(another.getFileName().toLowerCase());
+    }
+
+    public boolean equals(Object o) {
+        if(o instanceof OCFile){
+            OCFile that = (OCFile) o;
+            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]";
+        asString = String.format(asString, new Long(mId), getFileName(), mMimeType, isDownloaded(), mLocalPath, mRemotePath);
+        return asString;
+    }
+
 }