Refactoring file manager: moving volume mounting related code to a separate class.

chrome/browser/resources/file_manager/js/directory_model.js

 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 // If directory files changes too often, don't rescan directory more than once
 // per specified interval
 var SIMULTANEOUS_RESCAN_INTERVAL = 1000;
 // Used for operations that require almost instant rescan.
 var SHORT_RESCAN_INTERVAL = 100;
 
 /**
  * Data model of the file manager.
  *
  * @constructor
  * @param {DirectoryEntry} root File system root.
  * @param {boolean} singleSelection True if only one file could be selected
  *                                  at the time.
  * @param {boolean} showGData Defines whether GData root should be should
  *   (regardless of its mounts status).
  * @param {MetadataCache} metadataCache The metadata cache service.
  */
-function DirectoryModel(root, singleSelection, showGData, metadataCache) {
+function DirectoryModel(root, singleSelection, showGData,
+                        metadataCache, volumeManager) {
   this.root_ = root;
   this.metadataCache_ = metadataCache;
   this.fileList_ = new cr.ui.ArrayDataModel([]);
   this.fileListSelection_ = singleSelection ?
       new cr.ui.ListSingleSelectionModel() : new cr.ui.ListSelectionModel();
 
   this.showGData_ = showGData;
 
   this.runningScan_ = null;
   this.pendingScan_ = null;
@@ skipping 14 matching lines @@
    * A map root.fullPath -> currentDirectory.fullPath.
    * @private
    * @type {Object.<string, string>}
    */
   this.currentDirByRoot_ = {};
 
   // The map 'name' -> callback. Callbacks are function(entry) -> boolean.
   this.filters_ = {};
   this.setFilterHidden(true);
 
-  /**
-   * @private
-   * @type {Object.<string, boolean>}
-   */
-  this.volumeReadOnlyStatus_ = {};
+  if (this.showGData_) {
+    this.unmountedGDataEntry_ = {
+      unmouted: true,
+      fullPath: '/' + DirectoryModel.GDATA_DIRECTORY
+    };
+  }
+
+  this.volumeManager_ = volumeManager;
+  var volumesChangeHandler = this.onMountChanged_.bind(this);
+  this.updateRoots(function() {
+    volumeManager.addEventListener('change', volumesChangeHandler);
+  });
 }
 
 /**
  * The name of the directory containing externally
  * mounted removable storage volumes.
  */
 DirectoryModel.REMOVABLE_DIRECTORY = 'removable';
 
 /**
  * The name of the directory containing externally
@@ skipping 15 matching lines @@
 /**
 * The name of the downloads directory.
 */
 DirectoryModel.DOWNLOADS_DIRECTORY = 'Downloads';
 
 /**
 * The name of the gdata provider directory.
 */
 DirectoryModel.GDATA_DIRECTORY = 'drive';
 
+DirectoryModel.fakeGDataEntry_ = {
+  fullPath: '/' + DirectoryModel.GDATA_DIRECTORY
+};
+
 /**
  * DirectoryModel extends cr.EventTarget.
  */
 DirectoryModel.prototype.__proto__ = cr.EventTarget.prototype;
 
 /**
  * @return {cr.ui.ArrayDataModel} Files in the current directory.
  */
 DirectoryModel.prototype.getFileList = function() {
   return this.fileList_;
@@ skipping 58 matching lines @@
   return this.isPathReadOnly(this.getCurrentRootPath());
 };
 
 /**
  * @param {string} path Path to check.
  * @return {boolean} True if the |path| is read only.
  */
 DirectoryModel.prototype.isPathReadOnly = function(path) {
   switch (DirectoryModel.getRootType(path)) {
     case DirectoryModel.RootType.REMOVABLE:
-      return !!this.volumeReadOnlyStatus_[DirectoryModel.getRootPath(path)];
+      return !!this.volumeManager_.isReadOnly(DirectoryModel.getRootPath(path));
     case DirectoryModel.RootType.ARCHIVE:
       return true;
     case DirectoryModel.RootType.DOWNLOADS:
       return false;
     case DirectoryModel.RootType.GDATA:
       return this.isOffline();
     default:
       return true;
   }
 };
@@ skipping 120 matching lines @@
 };
 
 /**
  * @return {string} Root path for the current directory (parent directory is
  *     not navigatable for the user).
  */
 DirectoryModel.prototype.getCurrentRootPath = function() {
   return DirectoryModel.getRootPath(this.currentDirEntry_.fullPath);
 };
 
+DirectoryModel.prototype.getCurrentRootType = function() {
+  return DirectoryModel.getRootType(this.currentDirEntry_.fullPath);
+};
+
 /**
  * @return {cr.ui.ListSingleSelectionModel} Root list selection model.
  */
 DirectoryModel.prototype.getRootsListSelectionModel = function() {
   return this.rootsListSelection_;
 };
 
 /**
  * Add a filter for directory contents.
  * @param {string} name An identifier of the filter (used when removing it).
@@ skipping 155 matching lines @@
   }
 
   var onDone = function() {
     cr.dispatchSimpleEvent(this, 'scan-completed');
     callback();
   }.bind(this);
 
   // Clear the table first.
   this.fileList_.splice(0, this.fileList_.length);
   cr.dispatchSimpleEvent(this, 'scan-started');
-  if (this.currentDirEntry_ == this.unmountedGDataEntry_) {
+  if (this.currentDirEntry_ == DirectoryModel.fakeGDataEntry_) {
     onDone();
     return;
   }
   this.runningScan_ = this.createScanner_(this.fileList_, onDone);
   this.runningScan_.run();
 };
 
 /**
  * @private
  * @param {Array.<Entry>} entries Files.
@@ skipping 182 matching lines @@
 };
 
 /**
  * Resolves absolute directory path. Handles GData stub.
  * @param {string} path Path to the directory.
  * @param {function(DirectoryEntry} successCallback Success callback.
  * @param {function(FileError} errorCallback Error callback.
  */
 DirectoryModel.prototype.resolveDirectory = function(path, successCallback,
                                                      errorCallback) {
-  if (this.unmountedGDataEntry_ &&
-      DirectoryModel.getRootType(path) == DirectoryModel.RootType.GDATA) {
+  if (DirectoryModel.getRootType(path) == DirectoryModel.RootType.GDATA) {
     // TODO(kaznacheeev): Currently if path points to some GData subdirectory
     // and GData is not mounted we will change to the fake GData root and
     // ignore the rest of the path. Consider remembering the path and
     // changing to it once GDdata is mounted. This is only relevant for cases
     // when we open the File Manager with an URL pointing to GData (e.g. via
     // a bookmark).
-    successCallback(this.unmountedGDataEntry_);
-    return;
+    if (!this.isGDataMounted_()) {
+      if (path == DirectoryModel.fakeGDataEntry_.fullPath)
+        successCallback(DirectoryModel.fakeGDataEntry_);
+      else  // Subdirectory.
+        errorCallback({ code: FileError.NOT_FOUND_ERR });
+      return;
+    }
   }
 
   if (path == '/') {
     successCallback(this.root_);
     return;
   }
 
   this.root_.getDirectory(path, {create: false},
                           successCallback, errorCallback);
 };
@@ skipping 37 matching lines @@
  * changed.
  *
  * @private
  * @param {boolean} initial True if it comes from setupPath and
  *                          false if caused by an user action.
  * @param {DirectoryEntry} dirEntry The absolute path to the new directory.
  * @param {function} opt_callback Executed if the directory loads successfully.
  */
 DirectoryModel.prototype.changeDirectoryEntry_ = function(initial, dirEntry,
                                                           opt_callback) {
+  if (dirEntry == DirectoryModel.fakeGDataEntry_)
+    this.volumeManager_.mountGData(function() {}, function() {});
+
   var previous = this.currentDirEntry_;
   this.currentDirEntry_ = dirEntry;
   function onRescanComplete() {
     if (opt_callback)
       opt_callback();
     // For tests that open the dialog to empty directories, everything
     // is loaded at this point.
     chrome.test.sendMessage('directory-change-complete');
   }
   this.updateRootsListSelection_();
   this.scan_(onRescanComplete);
   this.currentDirByRoot_[this.getCurrentRootPath()] = dirEntry.fullPath;
 
   var e = new cr.Event('directory-changed');
   e.previousDirEntry = previous;
   e.newDirEntry = dirEntry;
   e.initial = initial;
   this.dispatchEvent(e);
 };
 
 /**
+ * Creates an object wich could cay wether directory has changed while it has

[dgozman, 2012/05/16 14:31:46]

typo: cay -> say

+ * been active or not. Designed for long operations that should be canncelled
+ * if the used change current directory.

[dgozman, 2012/05/16 14:31:46]

typo: used -> user

+ * @return {Object} Created object.
+ */
+DirectoryModel.prototype.createDirectoryChangeTracker = function() {
+  var tracker = {
+    dm_: this,
+    active_: false,
+    hasChanged: false,
+    exceptInitialChange: false,
+
+    start: function() {
+      if (!this.active_) {
+        this.dm_.addEventListener('directory-changed',
+                                  this.onDirectoryChange_);
+        this.active_ = true;
+        this.hasChanged = false;
+      }
+    },
+
+    stop: function() {
+      if (this.active_) {
+        this.dm_.removeEventListener('directory-changed',
+                                     this.onDirectoryChange_);
+        active_ = false;
+      }
+    },
+
+    onDirectoryChange_: function(event) {
+      if (tracker.exceptInitialChange && event.initial)
+        return;
+      // This is incorrect here.

[dgozman, 2012/05/16 14:31:46]

I agree that this is incorrect. Fix?

+      tracker.stop();
+      tracker.hasChange = true;
+    }
+  };
+  return tracker;
+};
+
+/**
  * Change the state of the model to reflect the specified path (either a
  * file or directory).
  *
  * @param {string} path The root path to use
  * @param {function=} opt_loadedCallback Invoked when the entire directory
  *     has been loaded and any default file selected.  If there are any
  *     errors loading the directory this will not get called (even if the
  *     directory loads OK on retry later). Will NOT be called if another
  *     directory change happened while setupPath was in progress.
  * @param {function=} opt_pathResolveCallback Invoked as soon as the path has
  *     been resolved, and called with the base and leaf portions of the path
  *     name, and a flag indicating if the entry exists. Will be called even
  *     if another directory change happened while setupPath was in progress,
  *     but will pass |false| as |exist| parameter.
  */
 DirectoryModel.prototype.setupPath = function(path, opt_loadedCallback,
                                               opt_pathResolveCallback) {
-  var overridden = false;
-  function onExternalDirChange() { overridden = true }
-  this.addEventListener('directory-changed', onExternalDirChange);
+  var tracker = this.createDirectoryChangeTracker();
+  tracker.start();
 
   var resolveCallback = function(exists) {
-    this.removeEventListener('directory-changed', onExternalDirChange);
-    if (opt_pathResolveCallback)
-      opt_pathResolveCallback(baseName, leafName, exists && !overridden);
+    tracker.stop();
+    if (opt_pathResolveCallback) {
+      opt_pathResolveCallback(baseName, leafName,
+                              exists && !tracker.hasChanged);
+    }
   }.bind(this);
 
   var changeDirectoryEntry = function(entry, initial, exists, opt_callback) {
+    tracker.stop();
     resolveCallback(exists);
-    if (!overridden)
+    if (!tracker.hasChanged)
       this.changeDirectoryEntry_(initial, entry, opt_callback);
   }.bind(this);
 
   var INITIAL = true;
   var EXISTS = true;
 
   // Split the dirname from the basename.
   var ary = path.match(/^(?:(.*)\/)?([^\/]*)$/);
 
   if (!ary) {
@@ skipping 33 matching lines @@
       console.log('Unexpected error resolving default leaf: ' + err);
     changeDirectoryEntry(baseDirEntry, INITIAL, !EXISTS);
   }
 
   var onBaseError = function(err) {
     console.log('Unexpected error resolving default base "' +
                 baseName + '": ' + err);
     if (path != this.getDefaultDirectory()) {
       // Can't find the provided path, let's go to default one instead.
       resolveCallback(!EXISTS);
-      if (!overridden)
+      if (!tracker.hasChanged)
         this.setupDefaultPath(opt_loadedCallback);
     } else {
       // Well, we can't find the downloads dir. Let's just show something,
       // or we will get an infinite recursion.
       changeDirectoryEntry(this.root_, opt_loadedCallback, INITIAL, !EXISTS);
     }
   }.bind(this);
 
   var onBaseFound = function(baseDirEntry) {
     if (!leafName) {
@@ skipping 75 matching lines @@
                                                         callback) {
   this.metadataCache_.get(entries, 'filesystem', function(properties) {
     callback();
   });
 };
 
 /**
  * Get root entries asynchronously.
  * @private
  * @param {function(Array.<Entry>)} callback Called when roots are resolved.
- * @param {boolean} resolveGData See comment for updateRoots.
  */
-DirectoryModel.prototype.resolveRoots_ = function(callback, resolveGData) {
+DirectoryModel.prototype.resolveRoots_ = function(callback) {
   var groups = {
     downloads: null,
     archives: null,
     removables: null,
     gdata: null
   };
   var self = this;
 
   metrics.startInterval('Load.Roots');
   function done() {
     for (var i in groups)
       if (!groups[i])
         return;
 
-    self.updateVolumeReadOnlyStatus_(groups.removables);
     callback(groups.downloads.
              concat(groups.gdata).
              concat(groups.archives).
              concat(groups.removables));
     metrics.recordInterval('Load.Roots');
   }
 
   function append(index, values, opt_error) {
     groups[index] = values;
     done();
   }
 
-  function onDownloads(entry) {
-    groups.downloads = [entry];
+  function appendSingle(index, entry) {
+    groups[index] = [entry];
     done();
   }
 
-  function onDownloadsError(error) {
-    groups.downloads = [];
-    done();
-  }
-
-  function onGData(entry) {
-    console.log('GData found:', entry);
-    self.unmountedGDataEntry_ = null;
-    groups.gdata = [entry];
-    done();
-  }
-
-  function onGDataError(error) {
-    console.log('GData error: ' + error);
-    self.unmountedGDataEntry_ = {
-      unmounted: true,  // Clients use this field to distinguish a fake root.
-      toURL: function() { return '' },
-      fullPath: '/' + DirectoryModel.GDATA_DIRECTORY
-    };
-    groups.gdata = [self.unmountedGDataEntry_];
+  function onSingleError(index, error, defaultValue) {
+    groups[index] = defailtValue || [];
     done();
   }
 
   var root = this.root_;
-  root.getDirectory(DirectoryModel.DOWNLOADS_DIRECTORY, { create: false },
-                    onDownloads, onDownloadsError);
+  function readSingle(dir, index, defaultValue) {
+    root.getDirectory(dir, { create: false },
+                      appendSingle.bind(this, index),
+                      onSingleError.bind(this, index, defaultValue));
+  }
+
+  readSingle(DirectoryModel.DOWNLOADS_DIRECTORY, 'downloads');
   util.readDirectory(root, DirectoryModel.ARCHIVE_DIRECTORY,
                      append.bind(this, 'archives'));
   util.readDirectory(root, DirectoryModel.REMOVABLE_DIRECTORY,
                      append.bind(this, 'removables'));
   if (this.showGData_) {
-    if (resolveGData) {
-      root.getDirectory(DirectoryModel.GDATA_DIRECTORY, { create: false },
-                        onGData, onGDataError);
-    } else {
-      onGDataError('lazy mount');
-    }
+    var fake = [DirectoryModel.fakeGDataEntry_];
+    if (this.isGDataMounted_())
+      readSingle(DirectoryModel.GDATA_DIRECTORY, 'gdata', fake);
+    else
+      groups.gdata = fake;
   } else {
     groups.gdata = [];
   }
 };
 
 /**
-* @param {function} opt_callback Called when all roots are resolved.
-* @param {boolean} opt_resolveGData If true GData should be resolved for real,
-*                                   If false a stub entry should be created.
+* @param {functioni?} opt_callback Called when all roots are resolved.

[dgozman, 2012/05/16 14:31:46]

typo: functioni?

 */
-DirectoryModel.prototype.updateRoots = function(opt_callback,
-                                                opt_resolveGData) {
+DirectoryModel.prototype.updateRoots = function(opt_callback) {
   var self = this;
   this.resolveRoots_(function(rootEntries) {
     var dm = self.rootsList_;
     var args = [0, dm.length].concat(rootEntries);
     dm.splice.apply(dm, args);
 
     self.updateRootsListSelection_();
-
-    if (opt_callback)
-      opt_callback();
-  }, opt_resolveGData);
+    opt_callback && opt_callback();

[dgozman, 2012/05/16 14:31:46]

I like the |if| construction much more.

+  });
 };
 
 /**
  * Find roots list item by root path.
  *
  * @param {string} path Root path.
  * @return {number} Index of the item.
  * @private
  */
 DirectoryModel.prototype.findRootsListItem_ = function(path) {
   var roots = this.rootsList_;
   for (var index = 0; index < roots.length; index++) {
     if (roots.item(index).fullPath == path)
       return index;
   }
   return -1;
 };
 
 /**
  * @private
  */
 DirectoryModel.prototype.updateRootsListSelection_ = function() {
   var rootPath = DirectoryModel.getRootPath(this.currentDirEntry_.fullPath);
   this.rootsListSelection_.selectedIndex = this.findRootsListItem_(rootPath);
 };
 
-/**
- * @param {Array.<DirectoryEntry>} roots Removable volumes entries.
- * @private
- */
-DirectoryModel.prototype.updateVolumeReadOnlyStatus_ = function(roots) {
-  var status = this.volumeReadOnlyStatus_ = {};
-  for (var i = 0; i < roots.length; i++) {
-    status[roots[i].fullPath] = false;
-    chrome.fileBrowserPrivate.getVolumeMetadata(roots[i].toURL(),
-        function(systemMetadata, path) {
-          status[path] = !!(systemMetadata && systemMetadata.isReadOnly);
-        }.bind(null, roots[i].fullPath));
+DirectoryModel.prototype.isGDataMounted_ = function() {
+  return this.volumeManager_.isMounted('/' + DirectoryModel.GDATA_DIRECTORY);
+};
+
+DirectoryModel.prototype.onMountChanged_ = function() {
+  this.updateRoots();
+
+  if (this.getCurrentRootType() != DirectoryModel.RootType.GDATA)
+    return;
+
+  var mounted = this.isGDataMounted_();
+  if (this.currentDirEntry_ == DirectoryModel.fakeGDataEntry_) {
+    if (mounted) {
+      // Change fake entry to real one and rescan.
+      this.root_.getDirectory('/' + DirectoryModel.GDATA_DIRECTORY, {},
+          function(entry) {
+        if (this.currentDirEntry_ == DirectoryModel.fakeGDataEntry_) {
+          this.currentDirEntry_ = entry;
+          this.rescan();
+        }
+      }.bind(this));
+    }
+  } else if (!mounted) {
+    // Current entry unmounted. replace with fake one.
+    if (this.currentDirEntry_.fullPath ==
+        DirectoryModel.fakeGDataEntry_.fullPath) {
+      // Replace silently and rescan.
+      this.currentDirEntry_ = DirectoryModel.fakeGDataEntry_;
+      this.rescan();
+    } else {
+      this.changeDirectoryEntry_(false, DirectoryModel.fakeGDataEntry_);
+    }
   }
 };
 
-/**
- * Prepare the root for the unmount.
- *
- * @param {string} rootPath The path to the root.
- */
-DirectoryModel.prototype.prepareUnmount = function(rootPath) {
-  var index = this.findRootsListItem_(rootPath);
-  if (index == -1) {
-    console.error('Unknown root entry', rootPath);
-    return;
-  }
-  var entry = this.rootsList_.item(index);
-
-  // We never need to remove this attribute because even if the unmount fails
-  // the onMountCompleted handler calls updateRoots which creates a new entry
-  // object for this volume.
-  entry.unmounting = true;
-
-  // Re-place the entry into the roots data model to force re-rendering.
-  this.rootsList_.splice(index, 1, entry);
-
-  if (rootPath == this.rootPath) {
-    // TODO(kaznacheev): Consider changing to the most recently used root.
-    this.changeDirectory(this.getDefaultDirectory());
-  }
-};
-
 /**
  * @param {string} path Any path.
  * @return {string} The root path.
  */
 DirectoryModel.getRootPath = function(path) {
   var type = DirectoryModel.getRootType(path);
 
   if (type == DirectoryModel.RootType.DOWNLOADS)
     return '/' + DirectoryModel.DOWNLOADS_DIRECTORY;
   if (type == DirectoryModel.RootType.GDATA)
@@ skipping 141 matching lines @@
 /**
  * @private
  */
 DirectoryModel.Scanner.prototype.recordMetrics_ = function() {
   metrics.recordInterval('DirectoryScan');
   if (this.dir_.fullPath ==
       '/' + DirectoryModel.DOWNLOADS_DIRECTORY) {
     metrics.recordMediumCount('DownloadsCount', this.list_.length);
   }
 };
+
+function FileWatcher(root, directoryModel, volumeManager) {
+  this.root_ = root;
+  this.dm_ = directoryModel;
+  this.vm_ = volumeManager;
+  this.watchedDirectoryEntry_ = null;
+  this.updateWatchedDirectoryBound_ =
+      this.updateWatchedDirectory_.bind(this);
+  this.onFileChangedBound_ =
+      this.onFileChanged_.bind(this);
+}
+
+FileWatcher.prototype.start = function() {
+  chrome.fileBrowserPrivate.onFileChanged.addListener(
+        this.onFileChangedBound_);
+
+  this.dm_.addEventListener('directory-changed',
+      this.updateWatchedDirectoryBound_);
+  this.vm_.addEventListener('changed',
+      this.updateWatchedDirectoryBound_);
+
+  this.updateWatchedDirectory_();
+};
+
+FileWatcher.prototype.stop = function() {
+  chrome.fileBrowserPrivate.onFileChanged.removeListener(
+        this.onFileChangedBound_);
+
+  this.dm_.removeEventListener('directory-changed',
+      this.updateWatchedDirectoryBound_);
+  this.vm_.removeEventListener('changed',
+      this.updateWatchedDirectoryBound_);
+
+  if (this.watchedDirectoryEntry_)
+    this.changeWatchedEntry(null);
+};
+
+FileWatcher.prototype.onFileChanged_ = function(event) {
+  if (encodeURI(event.fileUrl) == this.watchedDirectoryEntry_.toURL())
+    this.dm_.rescanLater();
+};
+
+FileWatcher.prototype.updateWatchedDirectory_ = function() {
+  var current = this.watchedDirectoryEntry_;
+  switch (this.dm_.getCurrentRootType()) {
+    case DirectoryModel.RootType.GDATA:
+      if (!this.vm_.isMounted('/' + DirectoryModel.GDATA_DIRECTORY))
+         break;

[dgozman, 2012/05/16 14:31:46]

I think, you mean |return| instead of |break| here and below.

[SeRya, 2012/05/18 11:31:48]

Break is correct. The code below need to be executed.

+    case DirectoryModel.RootType.DOWNLOADS:
+    case DirectoryModel.RootType.REMOVABLE:

[dgozman, 2012/05/16 14:31:46]

What about RootType.ARCHIVE?

[SeRya, 2012/05/18 11:31:48]

I assume they never change so we don't need to watch it.

+      if (!current || current.fullPath != this.dm_.getCurrentDirPath()) {
+        this.root_.getDirectory(this.dm_.getCurrentDirPath(), {},

[dgozman, 2012/05/16 14:31:46]

Why not use dm_.getCurrentDirectory ?

[SeRya, 2012/05/18 11:31:48]

getCurrentDirectory not always returns a valid Entry. Especially if GDATA just
mounted. Actually I believe we should get rid of getCurrentDirectory at all,
only let to ask path. Complexity related to fake entries should be encapsulated.

+                                this.changeWatchedEntry.bind(this));
+      }
+      break;
+  }
+  if (current)
+    this.changeWatchedEntry(null);
+};
+
+FileWatcher.prototype.changeWatchedEntry = function(entry) {
+  if (this.watchedDirectoryEntry_) {
+    chrome.fileBrowserPrivate.removeFileWatch(
+        this.watchedDirectoryEntry_.toURL(),
+        function(result) {
+          if (!result) {
+            console.log('Failed to remove file watch');
+          }
+        });
+  }
+  this.watchedDirectoryEntry_ = entry;
+
+  if (this.watchedDirectoryEntry_) {
+    chrome.fileBrowserPrivate.addFileWatch(
+        this.watchedDirectoryEntry_.toURL(),
+        function(result) {
+          if (!result) {
+            console.log('Failed to add file watch');
+            this.watchedDirectoryEntry_ = null;
+          }
+        }.bind(this));
+  }
+};