Add gdata content search to file_manager

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;
 
@@ skipping 39 matching lines @@
 
   // The map 'name' -> callback. Callbacks are function(entry) -> boolean.
   this.filters_ = {};
   this.setFilterHidden(true);
 
   /**
    * @private
    * @type {Object.<string, boolean>}
    */
   this.volumeReadOnlyStatus_ = {};
+
+  /**
+   * Directory in which search results are displayed. Not null iff search
+   * results are being displayed.
+   * @private
+   * @type {Entry}
+   */
+  this.searchDirEntry_ = null;
+
+  /**
+   * Is search in progress.
+   * @private
+   * @type {boolean}
+   */
+  this.isSearching_ = false;
 }
 
 /**
  * The name of the directory containing externally
  * mounted removable storage volumes.
  */
 DirectoryModel.REMOVABLE_DIRECTORY = 'removable';
 
 /**
  * The name of the directory containing externally
@@ skipping 16 matching lines @@
 * The name of the downloads directory.
 */
 DirectoryModel.DOWNLOADS_DIRECTORY = 'Downloads';
 
 /**
 * The name of the gdata provider directory.
 */
 DirectoryModel.GDATA_DIRECTORY = 'gdata';
 
 /**
+ * Root path used for displaying gdata content search results.
+ * Search results will be shown in directory 'GDATA_SEARCH_ROOT_PATH/query'.
+ *
+ * @const
+ * @type {string}
+ */
+DirectoryModel.GDATA_SEARCH_ROOT_PATH = '/gdata/.search';
+
+/**
+ * @const
+ * @type {Array.<string>}
+ */
+DirectoryModel.GDATA_SEARCH_ROOT_COMPONENTS = ['', 'gdata', '.search'];
+
+/**
  * 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 37 matching lines @@
 };
 
 /**
  * @return {boolean} True if current directory is read only.
  */
 DirectoryModel.prototype.isReadOnly = function() {
   return this.isPathReadOnly(this.getCurrentRootPath());
 };
 
 /**
+ * @return {boolean} True if search is in progress.
+ */
+DirectoryModel.prototype.isSearching = function() {
+  return this.isSearching_;
+};
+
+/**
+ * @return {boolean} True if we are currently showing search results.
+ */
+DirectoryModel.prototype.isOnGDataSearchDir = function() {
+  return this.getSearchOrCurrentDirEntry() != this.getCurrentDirEntry();
+};
+
+/**
  * @param {strin} 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)];
     case DirectoryModel.RootType.ARCHIVE:
       return true;
     case DirectoryModel.RootType.DOWNLOADS:
@@ skipping 35 matching lines @@
 };
 
 /**
  * @return {DirectoryEntry} Current directory.
  */
 DirectoryModel.prototype.getCurrentDirEntry = function() {
   return this.currentDirEntry_;
 };
 
 /**
+ * If search results are being displayed, returns search directory, else returns
+ * current directory.
+ *
+ * @return {DirectoryEntry} search or directory entry.
+ */
+DirectoryModel.prototype.getSearchOrCurrentDirEntry = function() {
+  return this.searchDirEntry_ || this.currentDirEntry_;
+};
+
+/**
  * @return {string} Path for the current directory.
  */
 DirectoryModel.prototype.getCurrentDirPath = function() {
   return this.currentDirEntry_.fullPath;
 };
 
 /**
  * @private
  * @return {Array.<string>} Names of selected files.
  */
@@ skipping 184 matching lines @@
     }
   }
 
   function onFailure() {
     self.scanFailures_++;
     if (self.scanFailures_ <= 1)
       self.rescanLater();
   }
 
   return new DirectoryModel.Scanner(
-      this.currentDirEntry_,
+      this.getSearchOrCurrentDirEntry(),
       list,
       onSuccess,
       onFailure,
       this.prefetchCacheForSorting_.bind(this),
       this.filters_);
 };
 
 /**
  * @private
  * @param {Array.<Entry>} entries List of files.
@@ skipping 67 matching lines @@
                                                              callback) {
   var field = this.fileList_.sortStatus.field;
   if (field) {
     this.prepareSortEntries_(entries, field, callback);
   } else {
     callback();
   }
 };
 
 /**
+ * Gets name that should be displayed in the UI for the entry.
+ * @param {string} path Full path of the entry whose display name we are
+ *                      getting.
+ * @param {string} defaultName Default name to use if no name is calculated.
+ * @return {string} Name to be used for display.
+ */
+DirectoryModel.prototype.getDisplayName = function(path, defaultName) {
+  var searchResultName = util.getFileAndDisplayNameForGDataSearchResult(path);
+  return searchResultName ? searchResultName.displayName : defaultName;
+};
+
+/**
+ * Creates file name that should be used as a new file name in filesystem
+ * operations while renaming. It the given entry is not a gdata search result

[dgozman, 2012/05/15 11:25:06]

typo: it -> if

[tbarzic, 2012/05/16 03:50:04]

Done.

+ * entry, |newName| will be used.

[dgozman, 2012/05/15 11:25:06]

typo: newName -> displayName

[tbarzic, 2012/05/16 03:50:04]

Done.

+ *
+ * @private
+ * @param {Entry} entry Entry which is being renamed.
+ * @param {string} displayName The new file name provided by user.
+ * @return {string} File name that should be used in renaming filesystem
+ *                 operations.
+ */
+DirectoryModel.prototype.getEntryName_ = function(entry, displayName) {

[dgozman, 2012/05/15 11:25:06]

Confusing name. I'd say that getEntryName == entry.name.
Consider something like getEntryNameAfterRename.

[tbarzic, 2012/05/16 03:50:04]

Done.

+  // If we are renaming gdata search result, we'll have to format newName to
+  // use in file system operation like: <resource_id>.<file_name>.
+  var searchResultName =
+      util.getFileAndDisplayNameForGDataSearchResult(entry.fullPath);
+  return searchResultName ? searchResultName.resourceId + '.' + displayName :
+                            displayName;
+};
+
+/**
  * Delete the list of files and directories from filesystem and
  * update the file list.
  * @param {Array.<Entry>} entries Entries to delete.
  * @param {function()=} opt_callback Called when finished.
  */
 DirectoryModel.prototype.deleteEntries = function(entries, opt_callback) {
   var downcount = entries.length + 1;
 
   var onComplete = opt_callback ? function() {
     if (--downcount == 0)
@@ skipping 16 matching lines @@
         onSuccess,
         util.flog('Error deleting ' + entry.fullPath, onComplete));
   }
   onComplete();
 };
 
 /**
  * @param {string} name Filename.
  */
 DirectoryModel.prototype.onEntryChanged = function(name) {
-  var currentEntry = this.currentDirEntry_;
+  var currentEntry = this.getSearchOrCurrentDirEntry();
+  if (currentEntry != this.currentDirEntry_)
+    return;
   var dm = this.fileList_;
   var self = this;
 
   function onEntryFound(entry) {
+    // Do nothing if current directory changed during async operations.
+    if (self.currentDirEntry_ != currentEntry)

[dgozman, 2012/05/15 11:25:06]

This should probably be:
if (self.getSearchOrCurrentDirEntry() != currentEntry)

[tbarzic, 2012/05/16 03:50:04]

Done.

+      return;
     self.prefetchCacheForSorting_([entry], function() {
       // Do nothing if current directory changed during async operations.
       if (self.currentDirEntry_ != currentEntry)
         return;
 
       var index = self.findIndexByName_(name);
       if (index >= 0)
         dm.splice(index, 1, entry);
       else
         dm.splice(dm.length, 0, entry);
     });
   };
 
   function onError(err) {
     // Do nothing if current directory changed during async operations.
     if (self.currentDirEntry_ != currentEntry)
       return;
     if (err.code != FileError.NOT_FOUND_ERR) {
       self.rescanLater();
       return;
     }
 
     var index = self.findIndexByName_(name);
     if (index >= 0)
       dm.splice(index, 1);
   };
 
-  util.resolvePath(this.currentDirEntry_, name, onEntryFound, onError);
+  util.resolvePath(currentEntry, name, onEntryFound, onError);
 };
 
 /**
  * @private
  * @param {string} name Filename.
  * @return {number} The index in the fileList.
  */
 DirectoryModel.prototype.findIndexByName_ = function(name) {
   var dm = this.fileList_;
   for (var i = 0; i < dm.length; i++)
     if (dm.item(i).name == name)
       return i;
   return -1;
 };
 
 /**
  * Rename the entry in the filesystem and update the file list.
  * @param {Entry} entry Entry to rename.
- * @param {string} newName New name.
+ * @param {string} newDisplayName New name.
  * @param {function} errorCallback Called on error.
  * @param {function} opt_successCallback Called on success.
  */
-DirectoryModel.prototype.renameEntry = function(entry, newName, errorCallback,
+DirectoryModel.prototype.renameEntry = function(entry, newDisplayName,
+                                                errorCallback,
                                                 opt_successCallback) {
   var self = this;
   function onSuccess(newEntry) {
     self.prefetchCacheForSorting_([newEntry], function() {
       var fileList = self.fileList_;
       var index = fileList.indexOf(entry);
       if (index >= 0)
         fileList.splice(index, 1, newEntry);
-      self.selectEntry(newName);
+      self.selectEntry(newEntry.name);
       // If the entry doesn't exist in the list it mean that it updated from
       // outside (probably by directory rescan).
       if (opt_successCallback)
         opt_successCallback();
     });
   }
-  entry.moveTo(this.currentDirEntry_, newName, onSuccess, errorCallback);
+
+  var newEntryName = this.getEntryName_(entry, newDisplayName);
+  entry.moveTo(this.getSearchOrCurrentDirEntry(), newEntryName, onSuccess,
+               errorCallback);
 };
 
 /**
  * Checks if current directory contains a file or directory with this name.
- * @param {string} newName Name to check.
+ * @param {string} entry Entry to which newName will be given.
+ * @param {string} displayName Name to check.
  * @param {function(boolean, boolean?)} callback Called when the result's
  *     available. First parameter is true if the entry exists and second
  *     is true if it's a file.
  */
-DirectoryModel.prototype.doesExist = function(newName, callback) {
-  util.resolvePath(this.currentDirEntry_, newName,
+DirectoryModel.prototype.doesExist = function(entry, displayName, callback) {
+  var entryName = this.getEntryName_(entry, displayName);
+
+  util.resolvePath(this.getSearchOrCurrentDirEntry(), entryName,

[dgozman, 2012/05/15 11:25:06]

What if new renamed name does not conform to search query? I guess, the renamed
entry will not be found in search directory.

Should we look into entry's real parent directory?

[tbarzic, 2012/05/16 03:50:04]

this case is handled in gdata code (a bit hacky, but I hope to get rid of it
soon)

       function(entry) {
         callback(true, entry.isFile);
       },
       callback.bind(window, false));
 };
 
 /**
  * Creates directory and updates the file list.
  *
  * @param {string} name Directory name.
@@ skipping 25 matching lines @@
   this.currentDirEntry_.getDirectory(name, {create: true, exclusive: true},
                                      onSuccess, errorCallback);
 };
 
 /**
  * Changes directory. Causes 'directory-change' event.
  *
  * @param {string} path New current directory path.
  */
 DirectoryModel.prototype.changeDirectory = function(path) {
-  this.resolveDirectory(path, function(directoryEntry) {
+  var targetPath = path;
+  // We should not be changing directory to gdata search path. If we do, default
+  // to gdata root.
+  if (DirectoryModel.isGDataSearchPath(path)) {
+    console.error('Attempt to change directory to search path.');
+    targetPath = '/' + DirectoryModel.GDATA_DIRECTORY;
+  }
+
+  this.resolveDirectory(targetPath, function(directoryEntry) {
     this.changeDirectoryEntry_(false, directoryEntry);
   }.bind(this), function(error) {
     console.error('Error changing directory to ' + path + ': ', error);
   });
 };
 
 /**
  * Resolves absolute directory path. Handles GData stub.
  * @param {string} path Path to the directory.
  * @param {function(DirectoryEntry} successCallback Success callback.
@@ skipping 49 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) {
+  this.clearSearch_();
   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_();
@@ skipping 358 matching lines @@
   // 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());
   }
 };
 
 /**
+ * Performs search and displays results. The search type is dependent on the
+ * current directory. If we are currently on gdata, server side content search
+ * over gdata mount point. If the current directory is not on the gdata, file
+ * name search over current directory wil be performed.
+ *
+ * @param {string} query Query that will be searched for.
+ */
+DirectoryModel.prototype.search = function(query) {
+   if (!query) {
+     this.clearSearch_();
+     return;
+   }
+
+   this.isSearching_ = true;
+
+   // If we are offline, let's fallback to file name search inside dir.
+   if (this.getRootType() == DirectoryModel.RootType.GDATA &&
+       !util.isOffline()) {
+     var self = this;
+     // Create shadow directory which will contein search results.

[dgozman, 2012/05/15 11:25:06]

typo: contein

[tbarzic, 2012/05/16 03:50:04]

Done.

+     this.root_.getDirectory(DirectoryModel.createGDataSearchPath(query),
+         {create: false},
+         function(dir) {
+           self.searchDirEntry_ = dir;
+           self.rescanSoon();
+         },
+         this.clearSearch_.bind(this));
+   } else {
+     this.searchDirEntry_ = this.currentDirEntry_;
+     this.addFilter(
+         'searchbox',
+          function(e) {
+            return e.name.substring(0, query.length) == query;
+          });
+   }
+};
+
+
+/**
+ * Clears any state set by previous searches.
+ * @private
+ */
+DirectoryModel.prototype.clearSearch_ = function() {
+  this.searchDirEntry_ = null;
+  this.isSearching_ = false;
+  // This will trigger rescan.
+  this.removeFilter('searchbox');

[dgozman, 2012/05/15 11:25:06]

We may not have this filter present. This will probably result in exception.

[tbarzic, 2012/05/16 03:50:04]

I haven't seen the exception when we are removing nonexistent filter, but added
check for that in removeFilter()

Done.

+};
+
+/**
  * @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)
     return '/' + DirectoryModel.GDATA_DIRECTORY;
@@ skipping 44 matching lines @@
  * @param {string} path A path.
  * @return {boolean} True if it is a path to the root.
  */
 DirectoryModel.isRootPath = function(path) {
   if (path[path.length - 1] == '/')
     path = path.substring(0, path.length - 1);
   return DirectoryModel.getRootPath(path) == path;
 };
 
 /**
+ * Checks if the provided path is under gdata search.
+ *
+ * @param {string} path Path to be tested.
+ * @return {boolean} Is the path gdata search path.
+ */
+DirectoryModel.isGDataSearchPath = function(path) {
+  return path == DirectoryModel.GDATA_SEARCH_ROOT_PATH ||
+         path.search(DirectoryModel.GDATA_SEARCH_ROOT_PATH + '/') == 0;

[dgozman, 2012/05/15 11:25:06]

search -> indexOf ?

[tbarzic, 2012/05/16 03:50:04]

Done.

+};
+
+/**
+ * Creates directory path in which gdata content search results for |query|
+ * should be displayed.
+ *
+ * @param {string} query Search query.
+ * @return {string} Virtual directory path for search results.
+ */
+DirectoryModel.createGDataSearchPath = function(query) {
+  return DirectoryModel.GDATA_SEARCH_ROOT_PATH + '/' + query;
+};
+
+/**
  * @constructor
  * @extends cr.EventTarget
  * @param {DirectoryEntry} dir Directory to scan.
  * @param {Array.<Entry>|cr.ui.ArrayDataModel} list Target to put the files.
  * @param {function} successCallback Callback to call when (and if) scan
  *     successfully completed.
  * @param {function} errorCallback Callback to call in case of IO error.
  * @param {function(Array.<Entry>):void, Function)} preprocessChunk
  *     Callback to preprocess each chunk of files.
  * @param {Object.<string, function(Entry):Boolean>} filters The map of filters
@@ skipping 76 matching lines @@
 /**
  * @private
  */
 DirectoryModel.Scanner.prototype.recordMetrics_ = function() {
   metrics.recordInterval('DirectoryScan');
   if (this.dir_.fullPath ==
       '/' + DirectoryModel.DOWNLOADS_DIRECTORY) {
     metrics.recordMediumCount('DownloadsCount', this.list_.length);
   }
 };