Changed navigation behavior again after some feedback ;-)
[pub/Android/ownCloud.git] / src / eu / alefzero / owncloud / datamodel / OCFile.java
index f377a04..46f5fa1 100644 (file)
 
 package eu.alefzero.owncloud.datamodel;
 
+import java.io.File;
 import java.util.Vector;
 
-import eu.alefzero.owncloud.db.ProviderMeta.ProviderTableMeta;
 import android.accounts.Account;
-import android.content.ContentProvider;
+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 length_;
-  private long creation_timestamp_;
-  private long modified_timestamp_;
-  private String path_;
-  private String storage_path_;
-  private String mimetype_;
-  
-  private ContentProvider cp_;
-  private Account account_;
-  
-  public OCFile(ContentProvider cp, Account account, long id) {
-    cp_ = cp;
-    account_ = account;
-    Cursor c = cp_.query(ProviderTableMeta.CONTENT_URI_FILE,
-        null,
-        ProviderTableMeta.FILE_ACCOUNT_OWNER + "=? AND " +
-        ProviderTableMeta._ID + "=?",
-        new String[]{account_.name, String.valueOf(id)},
-        null);
-    setFileData(c);
-  }
-  
-  public OCFile(ContentProvider cp, Account account, String path) {
-    cp_ = cp;
-    account_ = account;
-    Cursor c = cp_.query(ProviderTableMeta.CONTENT_URI_FILE,
-        null,
-        ProviderTableMeta.FILE_ACCOUNT_OWNER + "=? AND " +
-        ProviderTableMeta.FILE_PATH + "=?",
-        new String[]{account_.name, path},
-        null);
-    setFileData(c);
-    if (path_ != null) path_ = path;
-  }
-  
-  public long getFileId() { return id_; }
-  
-  public String getPath() { return path_; }
-  
-  public boolean fileExtist() { return id_ != -1; }
-  
-  public boolean isDirectory() { return mimetype_ != null && mimetype_.equals("dir"); }
-  
-  public boolean isDownloaded() { return storage_path_ != null; }
-  
-  public String getStoragePath() { return storage_path_; }
-  public void setStoragePath(String storage_path) { storage_path_ = storage_path; }
-  
-  public long getCreationTimestamp() { return creation_timestamp_; }
-  public void setCreationTimestamp(long creation_timestamp) { creation_timestamp_ = creation_timestamp; }
-
-  public long getModificationTimestamp() { return modified_timestamp_; }
-  public void setModificationTimestamp(long modification_timestamp) { modified_timestamp_ = modification_timestamp; }
-
-  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.CONTENT_TYPE, mimetype_);
-    
-    Uri new_entry = cp_.insert(ProviderTableMeta.CONTENT_URI, cv);
-    try {
-      id_ = Integer.parseInt(new_entry.getEncodedPath());
-    } catch (NumberFormatException e) {
-      Log.e(TAG, "Can't retrieve file id from uri: " + new_entry.toString() +
-                ", reason: " + e.getMessage());
-      id_ = -1; 
-    }
-  }
-  
-  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 = cp_.query(req_uri, null, null, null, null);
-
-      if (c.moveToFirst())
-        do {
-          long id = c.getLong(c.getColumnIndex(ProviderTableMeta._ID));
-          OCFile child = new OCFile(cp_, account_, id);
-          ret.add(child);
-        } while (c.moveToNext());
-
-      return ret;
-    }
-    return null;
-  }
-  
-  private void setFileData(Cursor c) {
-    id_ = -1;
-    path_ = null;
-    storage_path_ = null;
-    mimetype_ = null;
-    length_ = 0;
-    creation_timestamp_ = 0;
-    modified_timestamp_ = 0;  
-    if (c != null && c.moveToFirst()) {
-      id_ = c.getLong(c.getColumnIndex(ProviderTableMeta._ID));
-      path_ = c.getString(c.getColumnIndex(ProviderTableMeta.FILE_PATH));
-      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));
-    }
-  }
+       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));
+               }
+       }
 }