src/com/owncloud/android/datamodel/OCFile.java

   1 /**
   2  *   ownCloud Android client application
   3  *
   4  *   Copyright (C) 2012  Bartek Przybylski
   5  *   Copyright (C) 2015 ownCloud Inc.
   6  *
   7  *   This program is free software: you can redistribute it and/or modify
   8  *   it under the terms of the GNU General Public License version 2,
   9  *   as published by the Free Software Foundation.
  10  *
  11  *   This program is distributed in the hope that it will be useful,
  12  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  *   GNU General Public License for more details.
  15  *
  16  *   You should have received a copy of the GNU General Public License
  17  *   along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18  *
  19  */
  20
  21 package com.owncloud.android.datamodel;
  22
  23 import android.os.Parcel;
  24 import android.os.Parcelable;
  25
  26 import com.owncloud.android.lib.common.utils.Log_OC;
  27 import com.owncloud.android.utils.FileStorageUtils;
  28
  29 import java.io.File;
  30
  31 import third_parties.daveKoeller.AlphanumComparator;
  32 public class OCFile implements Parcelable, Comparable<OCFile> {
  33
  34     public static final Parcelable.Creator<OCFile> CREATOR = new Parcelable.Creator<OCFile>() {
  35         @Override
  36         public OCFile createFromParcel(Parcel source) {
  37             return new OCFile(source);
  38         }
  39
  40         @Override
  41         public OCFile[] newArray(int size) {
  42             return new OCFile[size];
  43         }
  44     };
  45
  46     public static final String PATH_SEPARATOR = "/";
  47     public static final String ROOT_PATH = PATH_SEPARATOR;
  48
  49     private static final String TAG = OCFile.class.getSimpleName();
  50
  51     private long mId;
  52     private long mParentId;
  53     private long mLength;
  54     private long mCreationTimestamp;
  55     private long mModifiedTimestamp;
  56     private long mModifiedTimestampAtLastSyncForData;
  57     private String mRemotePath;
  58     private String mLocalPath;
  59     private String mMimeType;
  60     private boolean mNeedsUpdating;
  61     private long mLastSyncDateForProperties;
  62     private long mLastSyncDateForData;
  63     private boolean mKeepInSync;
  64
  65     private String mEtag;
  66
  67     private boolean mShareByLink;
  68     private String mPublicLink;
  69
  70     private boolean mFavorite;
  71
  72     private String mPermissions;
  73     private String mRemoteId;
  74
  75     private boolean mNeedsUpdateThumbnail;
  76
  77     private boolean mIsDownloading;
  78
  79
  80     /**
  81      * Create new {@link OCFile} with given path.
  82      * <p/>
  83      * The path received must be URL-decoded. Path separator must be OCFile.PATH_SEPARATOR, and it must be the first character in 'path'.
  84      *
  85      * @param path The remote path of the file.
  86      */
  87     public OCFile(String path) {
  88         resetData();
  89         mNeedsUpdating = false;
  90         if (path == null || path.length() <= 0 || !path.startsWith(PATH_SEPARATOR)) {
  91             throw new IllegalArgumentException("Trying to create a OCFile with a non valid remote path: " + path);
  92         }
  93         mRemotePath = path;
  94     }
  95
  96     /**
  97      * Reconstruct from parcel
  98      *
  99      * @param source The source parcel
 100      */
 101     private OCFile(Parcel source) {
 102         mId = source.readLong();
 103         mParentId = source.readLong();
 104         mLength = source.readLong();
 105         mCreationTimestamp = source.readLong();
 106         mModifiedTimestamp = source.readLong();
 107         mModifiedTimestampAtLastSyncForData = source.readLong();
 108         mRemotePath = source.readString();
 109         mLocalPath = source.readString();
 110         mMimeType = source.readString();
 111         mNeedsUpdating = source.readInt() == 0;
 112         mKeepInSync = source.readInt() == 1;
 113         mLastSyncDateForProperties = source.readLong();
 114         mLastSyncDateForData = source.readLong();
 115         mEtag = source.readString();
 116         mShareByLink = source.readInt() == 1;
 117         mFavorite = source.readInt() == 1;
 118         mPublicLink = source.readString();
 119         mPermissions = source.readString();
 120         mRemoteId = source.readString();
 121         mNeedsUpdateThumbnail = source.readInt() == 0;
 122         mIsDownloading = source.readInt() == 0;
 123
 124     }
 125
 126     @Override
 127     public void writeToParcel(Parcel dest, int flags) {
 128         dest.writeLong(mId);
 129         dest.writeLong(mParentId);
 130         dest.writeLong(mLength);
 131         dest.writeLong(mCreationTimestamp);
 132         dest.writeLong(mModifiedTimestamp);
 133         dest.writeLong(mModifiedTimestampAtLastSyncForData);
 134         dest.writeString(mRemotePath);
 135         dest.writeString(mLocalPath);
 136         dest.writeString(mMimeType);
 137         dest.writeInt(mNeedsUpdating ? 1 : 0);
 138         dest.writeInt(mKeepInSync ? 1 : 0);
 139         dest.writeLong(mLastSyncDateForProperties);
 140         dest.writeLong(mLastSyncDateForData);
 141         dest.writeString(mEtag);
 142         dest.writeInt(mShareByLink ? 1 : 0);
 143         dest.writeInt(mFavorite ? 1 : 0);
 144         dest.writeString(mPublicLink);
 145         dest.writeString(mPermissions);
 146         dest.writeString(mRemoteId);
 147         dest.writeInt(mNeedsUpdateThumbnail ? 1 : 0);
 148         dest.writeInt(mIsDownloading ? 1 : 0);
 149     }
 150
 151     /**
 152      * Gets the ID of the file
 153      *
 154      * @return the file ID
 155      */
 156     public long getFileId() {
 157         return mId;
 158     }
 159
 160     /**
 161      * Returns the remote path of the file on ownCloud
 162      *
 163      * @return The remote path to the file
 164      */
 165     public String getRemotePath() {
 166         return mRemotePath;
 167     }
 168
 169     /**
 170      * Can be used to check, whether or not this file exists in the database
 171      * already
 172      *
 173      * @return true, if the file exists in the database
 174      */
 175     public boolean fileExists() {
 176         return mId != -1;
 177     }
 178
 179     /**
 180      * Use this to find out if this file is a folder.
 181      *
 182      * @return true if it is a folder
 183      */
 184     public boolean isFolder() {
 185         return mMimeType != null && mMimeType.equals("DIR");
 186     }
 187
 188     /**
 189      * Use this to check if this file is available locally
 190      *
 191      * @return true if it is
 192      */
 193     public boolean isDown() {
 194         if (mLocalPath != null && mLocalPath.length() > 0) {
 195             File file = new File(mLocalPath);
 196             return (file.exists());
 197         }
 198         return false;
 199     }
 200
 201     /**
 202      * The path, where the file is stored locally
 203      *
 204      * @return The local path to the file
 205      */
 206     public String getStoragePath() {
 207         return mLocalPath;
 208     }
 209
 210     /**
 211      * Can be used to set the path where the file is stored
 212      *
 213      * @param storage_path to set
 214      */
 215     public void setStoragePath(String storage_path) {
 216         mLocalPath = storage_path;
 217     }
 218
 219     /**
 220      * Get a UNIX timestamp of the file creation time
 221      *
 222      * @return A UNIX timestamp of the time that file was created
 223      */
 224     public long getCreationTimestamp() {
 225         return mCreationTimestamp;
 226     }
 227
 228     /**
 229      * Set a UNIX timestamp of the time the file was created
 230      *
 231      * @param creation_timestamp to set
 232      */
 233     public void setCreationTimestamp(long creation_timestamp) {
 234         mCreationTimestamp = creation_timestamp;
 235     }
 236
 237     /**
 238      * Get a UNIX timestamp of the file modification time.
 239      *
 240      * @return A UNIX timestamp of the modification time, corresponding to the value returned by the server
 241      * in the last synchronization of the properties of this file.
 242      */
 243     public long getModificationTimestamp() {
 244         return mModifiedTimestamp;
 245     }
 246
 247     /**
 248      * Set a UNIX timestamp of the time the time the file was modified.
 249      * <p/>
 250      * To update with the value returned by the server in every synchronization of the properties
 251      * of this file.
 252      *
 253      * @param modification_timestamp to set
 254      */
 255     public void setModificationTimestamp(long modification_timestamp) {
 256         mModifiedTimestamp = modification_timestamp;
 257     }
 258
 259
 260     /**
 261      * Get a UNIX timestamp of the file modification time.
 262      *
 263      * @return A UNIX timestamp of the modification time, corresponding to the value returned by the server
 264      * in the last synchronization of THE CONTENTS of this file.
 265      */
 266     public long getModificationTimestampAtLastSyncForData() {
 267         return mModifiedTimestampAtLastSyncForData;
 268     }
 269
 270     /**
 271      * Set a UNIX timestamp of the time the time the file was modified.
 272      * <p/>
 273      * To update with the value returned by the server in every synchronization of THE CONTENTS
 274      * of this file.
 275      *
 276      * @param modificationTimestamp to set
 277      */
 278     public void setModificationTimestampAtLastSyncForData(long modificationTimestamp) {
 279         mModifiedTimestampAtLastSyncForData = modificationTimestamp;
 280     }
 281
 282
 283     /**
 284      * Returns the filename and "/" for the root directory
 285      *
 286      * @return The name of the file
 287      */
 288     public String getFileName() {
 289         File f = new File(getRemotePath());
 290         return f.getName().length() == 0 ? ROOT_PATH : f.getName();
 291     }
 292
 293     /**
 294      * Sets the name of the file
 295      * <p/>
 296      * Does nothing if the new name is null, empty or includes "/" ; or if the file is the root directory
 297      */
 298     public void setFileName(String name) {
 299         Log_OC.d(TAG, "OCFile name changin from " + mRemotePath);
 300         if (name != null && name.length() > 0 && !name.contains(PATH_SEPARATOR) && !mRemotePath.equals(ROOT_PATH)) {
 301             String parent = (new File(getRemotePath())).getParent();
 302             parent = (parent.endsWith(PATH_SEPARATOR)) ? parent : parent + PATH_SEPARATOR;
 303             mRemotePath = parent + name;
 304             if (isFolder()) {
 305                 mRemotePath += PATH_SEPARATOR;
 306             }
 307             Log_OC.d(TAG, "OCFile name changed to " + mRemotePath);
 308         }
 309     }
 310
 311     /**
 312      * Can be used to get the Mimetype
 313      *
 314      * @return the Mimetype as a String
 315      */
 316     public String getMimetype() {
 317         return mMimeType;
 318     }
 319
 320     /**
 321      * Adds a file to this directory. If this file is not a directory, an
 322      * exception gets thrown.
 323      *
 324      * @param file to add
 325      * @throws IllegalStateException if you try to add a something and this is
 326      *                               not a directory
 327      */
 328     public void addFile(OCFile file) throws IllegalStateException {
 329         if (isFolder()) {
 330             file.mParentId = mId;
 331             mNeedsUpdating = true;
 332             return;
 333         }
 334         throw new IllegalStateException(
 335                 "This is not a directory where you can add stuff to!");
 336     }
 337
 338     /**
 339      * Used internally. Reset all file properties
 340      */
 341     private void resetData() {
 342         mId = -1;
 343         mRemotePath = null;
 344         mParentId = 0;
 345         mLocalPath = null;
 346         mMimeType = null;
 347         mLength = 0;
 348         mCreationTimestamp = 0;
 349         mModifiedTimestamp = 0;
 350         mModifiedTimestampAtLastSyncForData = 0;
 351         mLastSyncDateForProperties = 0;
 352         mLastSyncDateForData = 0;
 353         mKeepInSync = false;
 354         mNeedsUpdating = false;
 355         mEtag = null;
 356         mShareByLink = false;
 357         mFavorite = false;
 358         mPublicLink = null;
 359         mPermissions = null;
 360         mRemoteId = null;
 361         mNeedsUpdateThumbnail = false;
 362         mIsDownloading = false;
 363     }
 364
 365     /**
 366      * Sets the ID of the file
 367      *
 368      * @param file_id to set
 369      */
 370     public void setFileId(long file_id) {
 371         mId = file_id;
 372     }
 373
 374     /**
 375      * Sets the Mime-Type of the
 376      *
 377      * @param mimetype to set
 378      */
 379     public void setMimetype(String mimetype) {
 380         mMimeType = mimetype;
 381     }
 382
 383     /**
 384      * Sets the ID of the parent folder
 385      *
 386      * @param parent_id to set
 387      */
 388     public void setParentId(long parent_id) {
 389         mParentId = parent_id;
 390     }
 391
 392     /**
 393      * Sets the file size in bytes
 394      *
 395      * @param file_len to set
 396      */
 397     public void setFileLength(long file_len) {
 398         mLength = file_len;
 399     }
 400
 401     /**
 402      * Returns the size of the file in bytes
 403      *
 404      * @return The filesize in bytes
 405      */
 406     public long getFileLength() {
 407         return mLength;
 408     }
 409
 410     /**
 411      * Returns the ID of the parent Folder
 412      *
 413      * @return The ID
 414      */
 415     public long getParentId() {
 416         return mParentId;
 417     }
 418
 419     /**
 420      * Check, if this file needs updating
 421      *
 422      * @return
 423      */
 424     public boolean needsUpdatingWhileSaving() {
 425         return mNeedsUpdating;
 426     }
 427
 428     public boolean needsUpdateThumbnail() {
 429         return mNeedsUpdateThumbnail;
 430     }
 431
 432     public void setNeedsUpdateThumbnail(boolean needsUpdateThumbnail) {
 433         this.mNeedsUpdateThumbnail = needsUpdateThumbnail;
 434     }
 435
 436     public long getLastSyncDateForProperties() {
 437         return mLastSyncDateForProperties;
 438     }
 439
 440     public void setLastSyncDateForProperties(long lastSyncDate) {
 441         mLastSyncDateForProperties = lastSyncDate;
 442     }
 443
 444     public long getLastSyncDateForData() {
 445         return mLastSyncDateForData;
 446     }
 447
 448     public void setLastSyncDateForData(long lastSyncDate) {
 449         mLastSyncDateForData = lastSyncDate;
 450     }
 451
 452     public void setKeepInSync(boolean keepInSync) {
 453         mKeepInSync = keepInSync;
 454     }
 455
 456     public boolean keepInSync() {
 457         return mKeepInSync;
 458     }
 459
 460     @Override
 461     public int describeContents() {
 462         return ((Object) this).hashCode();
 463     }
 464
 465     @Override
 466     public int compareTo(OCFile another) {
 467         if (isFolder() && another.isFolder()) {
 468             return getRemotePath().toLowerCase().compareTo(another.getRemotePath().toLowerCase());
 469         } else if (isFolder()) {
 470             return -1;
 471         } else if (another.isFolder()) {
 472             return 1;
 473         }
 474         return new AlphanumComparator().compare(this, another);
 475     }
 476
 477     @Override
 478     public boolean equals(Object o) {
 479         if (o instanceof OCFile) {
 480             OCFile that = (OCFile) o;
 481             if (that != null) {
 482                 return this.mId == that.mId;
 483             }
 484         }
 485
 486         return false;
 487     }
 488
 489     @Override
 490     public String toString() {
 491         String asString = "[id=%s, name=%s, mime=%s, downloaded=%s, local=%s, remote=%s, parentId=%s, keepInSync=%s etag=%s]";
 492         asString = String.format(asString, Long.valueOf(mId), getFileName(), mMimeType, isDown(), mLocalPath, mRemotePath, Long.valueOf(mParentId), Boolean.valueOf(mKeepInSync), mEtag);
 493         return asString;
 494     }
 495
 496     public String getEtag() {
 497         return mEtag;
 498     }
 499
 500     public void setEtag(String etag) {
 501         this.mEtag = etag;
 502     }
 503
 504
 505     public boolean isShareByLink() {
 506         return mShareByLink;
 507     }
 508
 509     public void setShareByLink(boolean shareByLink) {
 510         this.mShareByLink = shareByLink;
 511     }
 512
 513     public boolean isFavorite() {
 514         return mFavorite;
 515     }
 516
 517     public void setFavorite(boolean mFavorite) {
 518         this.mFavorite = mFavorite;
 519     }
 520
 521     public String getPublicLink() {
 522         return mPublicLink;
 523     }
 524
 525     public void setPublicLink(String publicLink) {
 526         this.mPublicLink = publicLink;
 527     }
 528
 529     public long getLocalModificationTimestamp() {
 530         if (mLocalPath != null && mLocalPath.length() > 0) {
 531             File f = new File(mLocalPath);
 532             return f.lastModified();
 533         }
 534         return 0;
 535     }
 536
 537     /**
 538      * @return 'True' if the file contains audio
 539      */
 540     public boolean isAudio() {
 541         return (mMimeType != null && mMimeType.startsWith("audio/"));
 542     }
 543
 544     /**
 545      * @return 'True' if the file contains video
 546      */
 547     public boolean isVideo() {
 548         return (mMimeType != null && mMimeType.startsWith("video/"));
 549     }
 550
 551     /**
 552      * @return 'True' if the file contains an image
 553      */
 554     public boolean isImage() {
 555         return ((mMimeType != null && mMimeType.startsWith("image/")) ||
 556                 FileStorageUtils.getMimeTypeFromName(mRemotePath).startsWith("image/"));
 557     }
 558
 559     public String getPermissions() {
 560         return mPermissions;
 561     }
 562
 563     public void setPermissions(String permissions) {
 564         this.mPermissions = permissions;
 565     }
 566
 567     public String getRemoteId() {
 568         return mRemoteId;
 569     }
 570
 571     public void setRemoteId(String remoteId) {
 572         this.mRemoteId = remoteId;
 573     }
 574
 575     public boolean isDownloading() {
 576         return mIsDownloading;
 577     }
 578
 579     public void setDownloading(boolean isDownloading) {
 580         this.mIsDownloading = isDownloading;
 581     }
 582
 583     public boolean isSynchronizing() {
 584         // TODO real implementation
 585         return false;
 586     }
 587 }