src/eu/alefzero/owncloud/datamodel/OCFile.java

   1 /* ownCloud Android client application
   2  *   Copyright (C) 2012  Bartek Przybylski
   3  *
   4  *   This program is free software: you can redistribute it and/or modify
   5  *   it under the terms of the GNU General Public License as published by
   6  *   the Free Software Foundation, either version 3 of the License, or
   7  *   (at your option) any later version.
   8  *
   9  *   This program is distributed in the hope that it will be useful,
  10  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  *   GNU General Public License for more details.
  13  *
  14  *   You should have received a copy of the GNU General Public License
  15  *   along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16  *
  17  */
  18
  19 package eu.alefzero.owncloud.datamodel;
  20
  21 import java.io.File;
  22 import java.net.MalformedURLException;
  23 import java.net.URL;
  24
  25 import eu.alefzero.owncloud.files.services.FileDownloader;
  26
  27 import android.net.Uri;
  28 import android.os.Parcel;
  29 import android.os.Parcelable;
  30
  31 public class OCFile implements Parcelable, Comparable<OCFile> {
  32
  33     public static final Parcelable.Creator<OCFile> CREATOR = new Parcelable.Creator<OCFile>() {
  34         @Override
  35         public OCFile createFromParcel(Parcel source) {
  36             return new OCFile(source);
  37         }
  38
  39         @Override
  40         public OCFile[] newArray(int size) {
  41             return new OCFile[size];
  42         }
  43     };
  44
  45     public static final String PATH_SEPARATOR = "/";
  46
  47     private long mId;
  48     private long mParentId;
  49     private long mLength;
  50     private long mCreationTimestamp;
  51     private long mModifiedTimestamp;
  52     private String mRemotePath;
  53     private String mLocalPath;
  54     private String mMimeType;
  55     private boolean mNeedsUpdating;
  56     private long mLastSyncDate;
  57     private boolean mKeepInSync;
  58
  59     /**
  60      * Create new {@link OCFile} with given path.
  61      *
  62      * The path received must be URL-decoded. Path separator must be OCFile.PATH_SEPARATOR, and it must be the first character in 'path'.
  63      *
  64      * @param path The remote path of the file.
  65      */
  66     public OCFile(String path) {
  67         resetData();
  68         mNeedsUpdating = false;
  69         if (path == null || path.length() <= 0 || !path.startsWith(PATH_SEPARATOR)) {
  70             throw new IllegalArgumentException("Trying to create a OCFile with a non valid remote path: " + path);
  71         }
  72         mRemotePath = path;
  73     }
  74
  75     /**
  76      * Reconstruct from parcel
  77      *
  78      * @param source The source parcel
  79      */
  80     private OCFile(Parcel source) {
  81         mId = source.readLong();
  82         mParentId = source.readLong();
  83         mLength = source.readLong();
  84         mCreationTimestamp = source.readLong();
  85         mModifiedTimestamp = source.readLong();
  86         mRemotePath = source.readString();
  87         mLocalPath = source.readString();
  88         mMimeType = source.readString();
  89         mNeedsUpdating = source.readInt() == 0;
  90         mKeepInSync = source.readInt() == 1;
  91         mLastSyncDate = source.readLong();
  92     }
  93
  94     @Override
  95     public void writeToParcel(Parcel dest, int flags) {
  96         dest.writeLong(mId);
  97         dest.writeLong(mParentId);
  98         dest.writeLong(mLength);
  99         dest.writeLong(mCreationTimestamp);
 100         dest.writeLong(mModifiedTimestamp);
 101         dest.writeString(mRemotePath);
 102         dest.writeString(mLocalPath);
 103         dest.writeString(mMimeType);
 104         dest.writeInt(mNeedsUpdating ? 1 : 0);
 105         dest.writeInt(mKeepInSync ? 1 : 0);
 106         dest.writeLong(mLastSyncDate);
 107     }
 108
 109     /**
 110      * Gets the ID of the file
 111      *
 112      * @return the file ID
 113      */
 114     public long getFileId() {
 115         return mId;
 116     }
 117
 118     /**
 119      * Returns the remote path of the file on ownCloud
 120      *
 121      * @return The remote path to the file
 122      */
 123     public String getRemotePath() {
 124         return mRemotePath;
 125     }
 126
 127     /**
 128      * Can be used to check, whether or not this file exists in the database
 129      * already
 130      *
 131      * @return true, if the file exists in the database
 132      */
 133     public boolean fileExists() {
 134         return mId != -1;
 135     }
 136
 137     /**
 138      * Use this to find out if this file is a Directory
 139      *
 140      * @return true if it is a directory
 141      */
 142     public boolean isDirectory() {
 143         return mMimeType != null && mMimeType.equals("DIR");
 144     }
 145
 146     /**
 147      * Use this to check if this file is available locally
 148      *
 149      * @return true if it is
 150      */
 151     public boolean isDown() {
 152         if (mLocalPath != null && mLocalPath.length() > 0) {
 153             File file = new File(mLocalPath);
 154             return (file.exists());
 155         }
 156         return false;
 157     }
 158
 159     /**
 160      * The path, where the file is stored locally
 161      *
 162      * @return The local path to the file
 163      */
 164     public String getStoragePath() {
 165         return mLocalPath;
 166     }
 167
 168     /**
 169      * Can be used to set the path where the file is stored
 170      *
 171      * @param storage_path to set
 172      */
 173     public void setStoragePath(String storage_path) {
 174         mLocalPath = storage_path;
 175     }
 176
 177     /**
 178      * Get a UNIX timestamp of the file creation time
 179      *
 180      * @return A UNIX timestamp of the time that file was created
 181      */
 182     public long getCreationTimestamp() {
 183         return mCreationTimestamp;
 184     }
 185
 186     /**
 187      * Set a UNIX timestamp of the time the file was created
 188      *
 189      * @param creation_timestamp to set
 190      */
 191     public void setCreationTimestamp(long creation_timestamp) {
 192         mCreationTimestamp = creation_timestamp;
 193     }
 194
 195     /**
 196      * Get a UNIX timestamp of the file modification time
 197      *
 198      * @return A UNIX timestamp of the modification time
 199      */
 200     public long getModificationTimestamp() {
 201         return mModifiedTimestamp;
 202     }
 203
 204     /**
 205      * Set a UNIX timestamp of the time the time the file was modified.
 206      *
 207      * @param modification_timestamp to set
 208      */
 209     public void setModificationTimestamp(long modification_timestamp) {
 210         mModifiedTimestamp = modification_timestamp;
 211     }
 212
 213     /**
 214      * Returns the filename and "/" for the root directory
 215      *
 216      * @return The name of the file
 217      */
 218     public String getFileName() {
 219         File f = new File(getRemotePath());
 220         return f.getName().length() == 0 ? "/" : f.getName();
 221     }
 222
 223     /**
 224      * Can be used to get the Mimetype
 225      *
 226      * @return the Mimetype as a String
 227      */
 228     public String getMimetype() {
 229         return mMimeType;
 230     }
 231
 232     /**
 233      * Adds a file to this directory. If this file is not a directory, an
 234      * exception gets thrown.
 235      *
 236      * @param file to add
 237      * @throws IllegalStateException if you try to add a something and this is
 238      *             not a directory
 239      */
 240     public void addFile(OCFile file) throws IllegalStateException {
 241         if (isDirectory()) {
 242             file.mParentId = mId;
 243             mNeedsUpdating = true;
 244             return;
 245         }
 246         throw new IllegalStateException(
 247                 "This is not a directory where you can add stuff to!");
 248     }
 249
 250     /**
 251      * Used internally. Reset all file properties
 252      */
 253     private void resetData() {
 254         mId = -1;
 255         mRemotePath = null;
 256         mParentId = 0;
 257         mLocalPath = null;
 258         mMimeType = null;
 259         mLength = 0;
 260         mCreationTimestamp = 0;
 261         mModifiedTimestamp = 0;
 262         mLastSyncDate = 0;
 263         mKeepInSync = false;
 264         mNeedsUpdating = false;
 265     }
 266
 267     /**
 268      * Sets the ID of the file
 269      *
 270      * @param file_id to set
 271      */
 272     public void setFileId(long file_id) {
 273         mId = file_id;
 274     }
 275
 276     /**
 277      * Sets the Mime-Type of the
 278      *
 279      * @param mimetype to set
 280      */
 281     public void setMimetype(String mimetype) {
 282         mMimeType = mimetype;
 283     }
 284
 285     /**
 286      * Sets the ID of the parent folder
 287      *
 288      * @param parent_id to set
 289      */
 290     public void setParentId(long parent_id) {
 291         mParentId = parent_id;
 292     }
 293
 294     /**
 295      * Sets the file size in bytes
 296      *
 297      * @param file_len to set
 298      */
 299     public void setFileLength(long file_len) {
 300         mLength = file_len;
 301     }
 302
 303     /**
 304      * Returns the size of the file in bytes
 305      *
 306      * @return The filesize in bytes
 307      */
 308     public long getFileLength() {
 309         return mLength;
 310     }
 311
 312     /**
 313      * Returns the ID of the parent Folder
 314      *
 315      * @return The ID
 316      */
 317     public long getParentId() {
 318         return mParentId;
 319     }
 320
 321     /**
 322      * Check, if this file needs updating
 323      *
 324      * @return
 325      */
 326     public boolean needsUpdatingWhileSaving() {
 327         return mNeedsUpdating;
 328     }
 329
 330     public long getLastSyncDate() {
 331         return mLastSyncDate;
 332     }
 333
 334     public void setLastSyncDate(long lastSyncDate) {
 335         mLastSyncDate = lastSyncDate;
 336     }
 337
 338     public void setKeepInSync(boolean keepInSync) {
 339         mKeepInSync = keepInSync;
 340     }
 341
 342     public boolean keepInSync() {
 343         return mKeepInSync;
 344     }
 345
 346     @Override
 347     public int describeContents() {
 348         return this.hashCode();
 349     }
 350
 351     @Override
 352     public int compareTo(OCFile another) {
 353         if (isDirectory() && another.isDirectory()) {
 354             return getRemotePath().toLowerCase().compareTo(another.getRemotePath().toLowerCase());
 355         } else if (isDirectory()) {
 356             return -1;
 357         } else if (another.isDirectory()) {
 358             return 1;
 359         }
 360         return getRemotePath().toLowerCase().compareTo(another.getRemotePath().toLowerCase());
 361     }
 362
 363     public boolean equals(Object o) {
 364         if(o instanceof OCFile){
 365             OCFile that = (OCFile) o;
 366             if(that != null){
 367                 return this.mId == that.mId;
 368             }
 369         }
 370
 371         return false;
 372     }
 373
 374     @Override
 375     public String toString() {
 376         String asString = "[id=%s, name=%s, mime=%s, downloaded=%s, local=%s, remote=%s, parentId=%s, keepInSinc=%s]";
 377         asString = String.format(asString, new Long(mId), getFileName(), mMimeType, isDown(), mLocalPath, mRemotePath, new Long(mParentId), new Boolean(mKeepInSync));
 378         return asString;
 379     }
 380
 381 }