ui/file_manager/gallery/js/gallery_item.js

   1 // Copyright 2014 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 /**
   6  * Object representing an image item (a photo).
   7  *
   8  * @param {!FileEntry} entry Image entry.
   9  * @param {!EntryLocation} locationInfo Entry location information.
  10  * @param {MetadataItem} metadataItem
  11  * @param {ThumbnailMetadataItem} thumbnailMetadataItem
  12  * @param {boolean} original Whether the entry is original or edited.
  13  * @constructor
  14  * @struct
  15  */
  16 Gallery.Item = function(
  17     entry, locationInfo, metadataItem, thumbnailMetadataItem, original) {
  18   /**
  19    * @private {!FileEntry}
  20    */
  21   this.entry_ = entry;
  22
  23   /**
  24    * @private {!EntryLocation}
  25    */
  26   this.locationInfo_ = locationInfo;
  27
  28   /**
  29    * @private {MetadataItem}
  30    */
  31   this.metadataItem_ = metadataItem;
  32
  33   /**
  34    * @private {ThumbnailMetadataItem}
  35    */
  36   this.thumbnailMetadataItem_ = metadataItem;
  37
  38   // TODO(yawano): Change this.contentImage and this.screenImage to private
  39   // fields and provide utility methods for them (e.g. revokeFullImageCache).
  40   /**
  41    * The content cache is used for prefetching the next image when going through
  42    * the images sequentially. The real life photos can be large (18Mpix = 72Mb
  43    * pixel array) so we want only the minimum amount of caching.
  44    * @type {(HTMLCanvasElement|HTMLImageElement)}
  45    */
  46   this.contentImage = null;
  47
  48   /**
  49    * We reuse previously generated screen-scale images so that going back to a
  50    * recently loaded image looks instant even if the image is not in the content
  51    * cache any more. Screen-scale images are small (~1Mpix) so we can afford to
  52    * cache more of them.
  53    * @type {HTMLCanvasElement}
  54    */
  55   this.screenImage = null;
  56
  57   /**
  58    * Last accessed date to be used for selecting items whose cache are evicted.
  59    * @type {number}
  60    * @private
  61    */
  62   this.lastAccessed_ = Date.now();
  63
  64   /**
  65    * @type {boolean}
  66    * @private
  67    */
  68   this.original_ = original;
  69 };
  70
  71 /**
  72  * @return {!FileEntry} Image entry.
  73  */
  74 Gallery.Item.prototype.getEntry = function() { return this.entry_; };
  75
  76 /**
  77  * @return {!EntryLocation} Entry location information.
  78  */
  79 Gallery.Item.prototype.getLocationInfo = function() {
  80   return this.locationInfo_;
  81 };
  82
  83 /**
  84  * @return {MetadataItem} Metadata.
  85  */
  86 Gallery.Item.prototype.getMetadataItem = function() {
  87   return this.metadataItem_;
  88 };
  89
  90 /**
  91  * @param {!MetadataItem} metadata
  92  */
  93 Gallery.Item.prototype.setMetadataItem = function(metadata) {
  94   this.metadataItem_ = metadata;
  95 };
  96
  97 /**
  98  * @return {ThumbnailMetadataItem} Thumbnail metadata item.
  99  */
 100 Gallery.Item.prototype.getThumbnailMetadataItem = function() {
 101   return this.thumbnailMetadataItem_;
 102 };
 103
 104 /**
 105  * @param {!ThumbnailMetadataItem} item Thumbnail metadata item.
 106  */
 107 Gallery.Item.prototype.setThumbnailMetadataItem = function(item) {
 108   this.thumbnailMetadataItem_ = item;
 109 };
 110
 111 /**
 112  * @return {string} File name.
 113  */
 114 Gallery.Item.prototype.getFileName = function() {
 115   return this.entry_.name;
 116 };
 117
 118 /**
 119  * @return {boolean} True if this image has not been created in this session.
 120  */
 121 Gallery.Item.prototype.isOriginal = function() { return this.original_; };
 122
 123 /**
 124  * Obtains the last accessed date.
 125  * @return {number} Last accessed date.
 126  */
 127 Gallery.Item.prototype.getLastAccessedDate = function() {
 128   return this.lastAccessed_;
 129 };
 130
 131 /**
 132  * Updates the last accessed date.
 133  */
 134 Gallery.Item.prototype.touch = function() {
 135   this.lastAccessed_ = Date.now();
 136 };
 137
 138 // TODO: Localize?
 139 /**
 140  * @type {string} Suffix for a edited copy file name.
 141  * @const
 142  */
 143 Gallery.Item.COPY_SIGNATURE = ' - Edited';
 144
 145 /**
 146  * Regular expression to match '... - Edited'.
 147  * @type {!RegExp}
 148  * @const
 149  */
 150 Gallery.Item.REGEXP_COPY_0 =
 151     new RegExp('^(.+)' + Gallery.Item.COPY_SIGNATURE + '$');
 152
 153 /**
 154  * Regular expression to match '... - Edited (N)'.
 155  * @type {!RegExp}
 156  * @const
 157  */
 158 Gallery.Item.REGEXP_COPY_N =
 159     new RegExp('^(.+)' + Gallery.Item.COPY_SIGNATURE + ' \\((\\d+)\\)$');
 160
 161 /**
 162  * Creates a name for an edited copy of the file.
 163  *
 164  * @param {!DirectoryEntry} dirEntry Entry.
 165  * @param {string} newMimeType Mime type of new image.
 166  * @param {function(string)} callback Callback.
 167  * @private
 168  */
 169 Gallery.Item.prototype.createCopyName_ = function(
 170     dirEntry, newMimeType, callback) {
 171   var name = this.getFileName();
 172
 173   // If the item represents a file created during the current Gallery session
 174   // we reuse it for subsequent saves instead of creating multiple copies.
 175   if (!this.original_) {
 176     callback(name);
 177     return;
 178   }
 179
 180   var baseName = name.replace(/\.[^\.\/]+$/, '');
 181   var ext = newMimeType === 'image/jpeg' ? '.jpg' : '.png';
 182
 183   function tryNext(tries) {
 184     // All the names are used. Let's overwrite the last one.
 185     if (tries == 0) {
 186       setTimeout(callback, 0, baseName + ext);
 187       return;
 188     }
 189
 190     // If the file name contains the copy signature add/advance the sequential
 191     // number.
 192     var matchN = Gallery.Item.REGEXP_COPY_N.exec(baseName);
 193     var match0 = Gallery.Item.REGEXP_COPY_0.exec(baseName);
 194     if (matchN && matchN[1] && matchN[2]) {
 195       var copyNumber = parseInt(matchN[2], 10) + 1;
 196       baseName = matchN[1] + Gallery.Item.COPY_SIGNATURE +
 197           ' (' + copyNumber + ')';
 198     } else if (match0 && match0[1]) {
 199       baseName = match0[1] + Gallery.Item.COPY_SIGNATURE + ' (1)';
 200     } else {
 201       baseName += Gallery.Item.COPY_SIGNATURE;
 202     }
 203
 204     dirEntry.getFile(baseName + ext, {create: false, exclusive: false},
 205         tryNext.bind(null, tries - 1),
 206         callback.bind(null, baseName + ext));
 207   }
 208
 209   tryNext(10);
 210 };
 211
 212 /**
 213  * Writes the new item content to either the existing or a new file.
 214  *
 215  * @param {!VolumeManager} volumeManager Volume manager instance.
 216  * @param {!MetadataModel} metadataModel
 217  * @param {DirectoryEntry} fallbackDir Fallback directory in case the current
 218  *     directory is read only.
 219  * @param {boolean} overwrite Whether to overwrite the image to the item or not.
 220  * @param {!HTMLCanvasElement} canvas Source canvas.
 221  * @param {function(boolean)} callback Callback accepting true for success.
 222  */
 223 Gallery.Item.prototype.saveToFile = function(
 224     volumeManager, metadataModel, fallbackDir, overwrite, canvas, callback) {
 225   ImageUtil.metrics.startInterval(ImageUtil.getMetricName('SaveTime'));
 226
 227   var name = this.getFileName();
 228   var newMimeType = name.match(/\.jpe?g$/i) || FileType.isRaw(this.entry_) ?
 229       'image/jpeg' : 'image/png';
 230
 231   var onSuccess = function(entry) {
 232     var locationInfo = volumeManager.getLocationInfo(entry);
 233     if (!locationInfo) {
 234       // Reuse old location info if it fails to obtain location info.
 235       locationInfo = this.locationInfo_;
 236     }
 237     ImageUtil.metrics.recordEnum(ImageUtil.getMetricName('SaveResult'), 1, 2);
 238     ImageUtil.metrics.recordInterval(ImageUtil.getMetricName('SaveTime'));
 239
 240     this.entry_ = entry;
 241     this.locationInfo_ = locationInfo;
 242
 243     // Updates the metadata.
 244     metadataModel.notifyEntriesChanged([this.entry_]);
 245     Promise.all([
 246       metadataModel.get([entry], Gallery.PREFETCH_PROPERTY_NAMES),
 247       new ThumbnailModel(metadataModel).get([entry])
 248     ]).then(function(metadataLists) {
 249       this.metadataItem_ = metadataLists[0][0];
 250       this.thumbnailMetadataItem_ = metadataLists[1][0];
 251       callback(true);
 252     }.bind(this), function() {
 253       callback(false);
 254     });
 255   }.bind(this);
 256
 257   var onError = function(error) {
 258     console.error('Error saving from gallery', name, error);
 259     ImageUtil.metrics.recordEnum(ImageUtil.getMetricName('SaveResult'), 0, 2);
 260     if (callback)
 261       callback(false);
 262   };
 263
 264   var doSave = function(newFile, fileEntry) {
 265     var blob;
 266     var fileWriter;
 267
 268     metadataModel.get(
 269         [fileEntry],
 270         ['mediaMimeType', 'contentMimeType', 'ifd', 'exifLittleEndian']
 271     ).then(function(metadataItems) {
 272       // Create the blob of new image.
 273       var metadataItem = metadataItems[0];
 274       metadataItem.modificationTime = new Date();
 275       metadataItem.mediaMimeType = newMimeType;
 276       var metadataEncoder = ImageEncoder.encodeMetadata(
 277           metadataItem, canvas, /* quality for thumbnail*/ 0.8);
 278       // Contrary to what one might think 1.0 is not a good default. Opening
 279       // and saving an typical photo taken with consumer camera increases
 280       // its file size by 50-100%. Experiments show that 0.9 is much better.
 281       // It shrinks some photos a bit, keeps others about the same size, but
 282       // does not visibly lower the quality.
 283       blob = ImageEncoder.getBlob(canvas, metadataEncoder, 0.9);
 284     }.bind(this)).then(function() {
 285       // Create writer.
 286       return new Promise(function(fullfill, reject) {
 287         fileEntry.createWriter(fullfill, reject);
 288       });
 289     }).then(function(writer) {
 290       fileWriter = writer;
 291
 292       // Truncates the file to 0 byte if it overwrites.
 293       return new Promise(function(fulfill, reject) {
 294         if (!newFile) {
 295           fileWriter.onerror = reject;
 296           fileWriter.onwriteend = fulfill;
 297           fileWriter.truncate(0);
 298         } else {
 299           fulfill(null);
 300         }
 301       });
 302     }).then(function() {
 303       // Writes the blob of new image.
 304       return new Promise(function(fulfill, reject) {
 305         fileWriter.onerror = reject;
 306         fileWriter.onwriteend = fulfill;
 307         fileWriter.write(blob);
 308       });
 309     }).then(onSuccess.bind(null, fileEntry))
 310     .catch(function(error) {
 311       onError(error);
 312       if (fileWriter) {
 313         // Disable all callbacks on the first error.
 314         fileWriter.onerror = null;
 315         fileWriter.onwriteend = null;
 316       }
 317     });
 318   }.bind(this);
 319
 320   var getFile = function(dir, newFile) {
 321     dir.getFile(name, {create: newFile, exclusive: newFile},
 322         function(fileEntry) {
 323           doSave(newFile, fileEntry);
 324         }.bind(this), onError);
 325   }.bind(this);
 326
 327   var checkExistence = function(dir) {
 328     dir.getFile(name, {create: false, exclusive: false},
 329         getFile.bind(null, dir, false /* existing file */),
 330         getFile.bind(null, dir, true /* create new file */));
 331   };
 332
 333   var saveToDir = function(dir) {
 334     if (overwrite &&
 335         !this.locationInfo_.isReadOnly &&
 336         !FileType.isRaw(this.entry_)) {
 337       checkExistence(dir);
 338     } else {
 339       this.createCopyName_(dir, newMimeType, function(copyName) {
 340         this.original_ = false;
 341         name = copyName;
 342         checkExistence(dir);
 343       }.bind(this));
 344     }
 345   }.bind(this);
 346
 347   if (this.locationInfo_.isReadOnly) {
 348     saveToDir(fallbackDir);
 349   } else {
 350     this.entry_.getParent(saveToDir, onError);
 351   }
 352 };
 353
 354 /**
 355  * Renames the item.
 356  *
 357  * @param {string} displayName New display name (without the extension).
 358  * @return {!Promise} Promise fulfilled with when renaming completes, or
 359  *     rejected with the error message.
 360  */
 361 Gallery.Item.prototype.rename = function(displayName) {
 362   var newFileName = this.entry_.name.replace(
 363       ImageUtil.getDisplayNameFromName(this.entry_.name), displayName);
 364
 365   if (newFileName === this.entry_.name)
 366     return Promise.reject('NOT_CHANGED');
 367
 368   if (/^\s*$/.test(displayName))
 369     return Promise.reject(str('ERROR_WHITESPACE_NAME'));
 370
 371   var parentDirectoryPromise = new Promise(
 372       this.entry_.getParent.bind(this.entry_));
 373   return parentDirectoryPromise.then(function(parentDirectory) {
 374     var nameValidatingPromise =
 375         util.validateFileName(parentDirectory, newFileName, true);
 376     return nameValidatingPromise.then(function() {
 377       var existingFilePromise = new Promise(parentDirectory.getFile.bind(
 378           parentDirectory, newFileName, {create: false, exclusive: false}));
 379       return existingFilePromise.then(function() {
 380         return Promise.reject(str('GALLERY_FILE_EXISTS'));
 381       }, function() {
 382         return new Promise(
 383             this.entry_.moveTo.bind(this.entry_, parentDirectory, newFileName));
 384       }.bind(this));
 385     }.bind(this));
 386   }.bind(this)).then(function(entry) {
 387     this.entry_ = entry;
 388   }.bind(this));
 389 };