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