Merge pull request #8008 from SAPlayer/issue-8003

JeffryBooher · JeffryBooher · commit 2ee5a98b40ee · 2014-07-21T14:08:23.000-07:00
Use correct error message when renaming/deleting folder
diff --git a/src/nls/root/strings.js b/src/nls/root/strings.js
@@ -40,15 +40,17 @@ define({
     "UNSUPPORTED_ENCODING_ERR"          : "{APP_NAME} currently only supports UTF-8 encoded text files.",
     "FILE_EXISTS_ERR"                   : "The file or directory already exists.",
     "FILE"                              : "file",
+    "FILE_TITLE"                        : "File",
     "DIRECTORY"                         : "directory",
+    "DIRECTORY_TITLE"                   : "Directory",
     "DIRECTORY_NAMES_LEDE"              : "Directory names",
     "FILENAMES_LEDE"                    : "Filenames",
-    "FILENAME"                          : "filename",
-    "DIRECTORY_NAME"                    : "directory name",
+    "FILENAME"                          : "Filename",
+    "DIRECTORY_NAME"                    : "Directory Name",
     
 
     // Project error strings
-    "ERROR_LOADING_PROJECT"             : "Error loading project",
+    "ERROR_LOADING_PROJECT"             : "Error Loading Project",
     "OPEN_DIALOG_ERROR"                 : "An error occurred when showing the open file dialog. (error {0})",
     "REQUEST_NATIVE_FILE_SYSTEM_ERROR"  : "An error occurred when trying to load the directory <span class='dialog-filename'>{0}</span>. (error {1})",
     "READ_DIRECTORY_ENTRIES_ERROR"      : "An error occurred when reading the contents of the directory <span class='dialog-filename'>{0}</span>. (error {1})",
@@ -61,10 +63,10 @@ define({
     "ERROR_RELOADING_FILE"              : "An error occurred when trying to reload the file <span class='dialog-filename'>{0}</span>. {1}",
     "ERROR_SAVING_FILE_TITLE"           : "Error Saving File",
     "ERROR_SAVING_FILE"                 : "An error occurred when trying to save the file <span class='dialog-filename'>{0}</span>. {1}",
-    "ERROR_RENAMING_FILE_TITLE"         : "Error Renaming File",
-    "ERROR_RENAMING_FILE"               : "An error occurred when trying to rename the file <span class='dialog-filename'>{0}</span>. {1}",
-    "ERROR_DELETING_FILE_TITLE"         : "Error Deleting File",
-    "ERROR_DELETING_FILE"               : "An error occurred when trying to delete the file <span class='dialog-filename'>{0}</span>. {1}",
+    "ERROR_RENAMING_FILE_TITLE"         : "Error Renaming {0}",
+    "ERROR_RENAMING_FILE"               : "An error occurred when trying to rename the {2} <span class='dialog-filename'>{0}</span>. {1}",
+    "ERROR_DELETING_FILE_TITLE"         : "Error Deleting {0}",
+    "ERROR_DELETING_FILE"               : "An error occurred when trying to delete the {2} <span class='dialog-filename'>{0}</span>. {1}",
     "INVALID_FILENAME_TITLE"            : "Invalid {0}",
     "INVALID_FILENAME_MESSAGE"          : "{0} cannot use any system reserved words, end with dots (.) or use any of the following characters: <code class='emphasized'>{1}</code>",
     "ENTRY_WITH_SAME_NAME_EXISTS"       : "A file or directory with the name <span class='dialog-filename'>{0}</span> already exists.",
@@ -183,7 +185,7 @@ define({
     "REPLACE_IN_FILES_ERRORS_TITLE"     : "Replace Errors",
     "REPLACE_IN_FILES_ERRORS"           : "The following files weren't modified because they changed after the search or couldn't be written.",
     
-    "ERROR_FETCHING_UPDATE_INFO_TITLE"  : "Error getting update info",
+    "ERROR_FETCHING_UPDATE_INFO_TITLE"  : "Error Getting Update Info",
     "ERROR_FETCHING_UPDATE_INFO_MSG"    : "There was a problem getting the latest update information from the server. Please make sure you are connected to the internet and try again.",
     
     // File exclusion filters
diff --git a/src/project/ProjectManager.js b/src/project/ProjectManager.js
@@ -115,6 +115,22 @@ define(function (require, exports, module) {
      */
     var SETTINGS_FILENAME = "." + PreferencesManager.SETTINGS_FILENAME;
 
+    /**
+     * @const
+     * @private
+     * Error context to show the correct error message
+     * @type {int}
+     */
+    var ERR_TYPE_CREATE = 1,
+        ERR_TYPE_CREATE_EXISTS = 2,
+        ERR_TYPE_RENAME = 3,
+        ERR_TYPE_DELETE = 4,
+        ERR_TYPE_LOADING_PROJECT = 5,
+        ERR_TYPE_LOADING_PROJECT_NATIVE = 6,
+        ERR_TYPE_MAX_FILES = 7,
+        ERR_TYPE_OPEN_DIALOG = 8,
+        ERR_TYPE_INVALID_FILENAME = 9;
+
     /**
      * @private
      * Reference to the tree control container div. Initialized by
@@ -764,6 +780,62 @@ define(function (require, exports, module) {
         return Async.withTimeout(result.promise(), 1000);
     }
     
+    function _showErrorDialog(errType, isFolder, error, path) {
+        var titleType = isFolder ? Strings.DIRECTORY_TITLE : Strings.FILE_TITLE,
+            entryType = isFolder ? Strings.DIRECTORY : Strings.FILE,
+            title,
+            message;
+        path = StringUtils.breakableUrl(path);
+
+        switch (errType) {
+        case ERR_TYPE_CREATE:
+            title = StringUtils.format(Strings.ERROR_CREATING_FILE_TITLE, titleType);
+            message = StringUtils.format(Strings.ERROR_CREATING_FILE, entryType, path, error);
+            break;
+        case ERR_TYPE_CREATE_EXISTS:
+            title = StringUtils.format(Strings.INVALID_FILENAME_TITLE, titleType);
+            message = StringUtils.format(Strings.ENTRY_WITH_SAME_NAME_EXISTS, path);
+            break;
+        case ERR_TYPE_RENAME:
+            title = StringUtils.format(Strings.ERROR_RENAMING_FILE_TITLE, titleType);
+            message = StringUtils.format(Strings.ERROR_RENAMING_FILE, path, error, entryType);
+            break;
+        case ERR_TYPE_DELETE:
+            title = StringUtils.format(Strings.ERROR_DELETING_FILE_TITLE, titleType);
+            message = StringUtils.format(Strings.ERROR_DELETING_FILE, path, error, entryType);
+            break;
+        case ERR_TYPE_LOADING_PROJECT:
+            title = Strings.ERROR_LOADING_PROJECT;
+            message = StringUtils.format(Strings.READ_DIRECTORY_ENTRIES_ERROR, path, error);
+            break;
+        case ERR_TYPE_LOADING_PROJECT_NATIVE:
+            title = Strings.ERROR_LOADING_PROJECT;
+            message = StringUtils.format(Strings.REQUEST_NATIVE_FILE_SYSTEM_ERROR, path, error);
+            break;
+        case ERR_TYPE_MAX_FILES:
+            title = Strings.ERROR_MAX_FILES_TITLE;
+            message = Strings.ERROR_MAX_FILES;
+            break;
+        case ERR_TYPE_OPEN_DIALOG:
+            title = Strings.ERROR_LOADING_PROJECT;
+            message = StringUtils.format(Strings.OPEN_DIALOG_ERROR, error);
+            break;
+        case ERR_TYPE_INVALID_FILENAME:
+            title = StringUtils.format(Strings.INVALID_FILENAME_TITLE, isFolder ? Strings.DIRECTORY_NAME : Strings.FILENAME);
+            message = StringUtils.format(Strings.INVALID_FILENAME_MESSAGE, isFolder ? Strings.DIRECTORY_NAMES_LEDE : Strings.FILENAMES_LEDE, error);
+            break;
+        }
+
+        if (title && message) {
+            return Dialogs.showModalDialog(
+                DefaultDialogs.DIALOG_ID_ERROR,
+                title,
+                message
+            );
+        }
+        return null;
+    }
+    
     /**
      * @private
      * See shouldShow
@@ -945,15 +1017,7 @@ define(function (require, exports, module) {
         // Fetch dirEntry's contents
         dirEntry.getContents(function (err, contents, stats, statsErrs) {
             if (err) {
-                Dialogs.showModalDialog(
-                    DefaultDialogs.DIALOG_ID_ERROR,
-                    Strings.ERROR_LOADING_PROJECT,
-                    StringUtils.format(
-                        Strings.READ_DIRECTORY_ENTRIES_ERROR,
-                        StringUtils.breakableUrl(dirEntry.fullPath),
-                        err
-                    )
-                );
+                _showErrorDialog(ERR_TYPE_LOADING_PROJECT, null, err, dirEntry.fullPath);
                 // Reject the render promise so we can move on.
                 deferred.reject();
             } else {
@@ -1049,25 +1113,13 @@ define(function (require, exports, module) {
         return updateWelcomeProjectPath(PreferencesManager.getViewState("projectPath"));
     }
     
-    /**
-     * Error dialog when max files in index is hit
-     * @return {Dialog}
-     */
-    function _showMaxFilesDialog() {
-        return Dialogs.showModalDialog(
-            DefaultDialogs.DIALOG_ID_ERROR,
-            Strings.ERROR_MAX_FILES_TITLE,
-            Strings.ERROR_MAX_FILES
-        );
-    }
-    
     function _watchProjectRoot(rootPath) {
         FileSystem.on("change", _fileSystemChange);
         FileSystem.on("rename", _fileSystemRename);
 
         FileSystem.watch(FileSystem.getDirectoryForPath(rootPath), _shouldShowName, function (err) {
             if (err === FileSystemError.TOO_MANY_ENTRIES) {
-                _showMaxFilesDialog();
+                _showErrorDialog(ERR_TYPE_MAX_FILES);
             } else if (err) {
                 console.error("Error watching project root: ", rootPath, err);
             }
@@ -1200,7 +1252,6 @@ define(function (require, exports, module) {
                     if (exists) {
                         var projectRootChanged = (!_projectRoot || !rootEntry) ||
                             _projectRoot.fullPath !== rootEntry.fullPath;
-                        var i;
                         
                         // Success!
                         var perfTimerName = PerfUtils.markStart("Load Project: " + rootPath);
@@ -1246,31 +1297,24 @@ define(function (require, exports, module) {
                             PerfUtils.addMeasurement(perfTimerName);
                         });
                     } else {
-                        Dialogs.showModalDialog(
-                            DefaultDialogs.DIALOG_ID_ERROR,
-                            Strings.ERROR_LOADING_PROJECT,
-                            StringUtils.format(
-                                Strings.REQUEST_NATIVE_FILE_SYSTEM_ERROR,
-                                StringUtils.breakableUrl(rootPath),
-                                err || FileSystemError.NOT_FOUND
-                            )
-                        ).done(function () {
-                            // Reset _projectRoot to null so that the following _loadProject call won't 
-                            // run the 'beforeProjectClose' event a second time on the original project, 
-                            // which is now partially torn down (see #6574).
-                            _projectRoot = null;
-                            
-                            // The project folder stored in preference doesn't exist, so load the default
-                            // project directory.
-                            // TODO (issue #267): When Brackets supports having no project directory
-                            // defined this code will need to change
-                            _loadProject(_getWelcomeProjectPath()).always(function () {
-                                // Make sure not to reject the original deferred until the fallback
-                                // project is loaded, so we don't violate expectations that there is always
-                                // a current project before continuing after _loadProject().
-                                result.reject();
+                        _showErrorDialog(ERR_TYPE_LOADING_PROJECT_NATIVE, null, rootPath, err || FileSystemError.NOT_FOUND)
+                            .done(function () {
+                                // Reset _projectRoot to null so that the following _loadProject call won't 
+                                // run the 'beforeProjectClose' event a second time on the original project, 
+                                // which is now partially torn down (see #6574).
+                                _projectRoot = null;
+
+                                // The project folder stored in preference doesn't exist, so load the default
+                                // project directory.
+                                // TODO (issue #267): When Brackets supports having no project directory
+                                // defined this code will need to change
+                                _loadProject(_getWelcomeProjectPath()).always(function () {
+                                    // Make sure not to reject the original deferred until the fallback
+                                    // project is loaded, so we don't violate expectations that there is always
+                                    // a current project before continuing after _loadProject().
+                                    result.reject();
+                                });
                             });
-                        });
                     }
                 });
             }
@@ -1522,11 +1566,7 @@ define(function (require, exports, module) {
                                 result.reject();
                             }
                         } else {
-                            Dialogs.showModalDialog(
-                                DefaultDialogs.DIALOG_ID_ERROR,
-                                Strings.ERROR_LOADING_PROJECT,
-                                StringUtils.format(Strings.OPEN_DIALOG_ERROR, err)
-                            );
+                            _showErrorDialog(ERR_TYPE_OPEN_DIALOG, null, err);
                             result.reject();
                         }
                     });
@@ -1565,11 +1605,7 @@ define(function (require, exports, module) {
         // See https://msdn.microsoft.com/en-us/library/windows/desktop/aa365247(v=vs.85).aspx
         if ((filename.search(new RegExp("[" + _invalidChars + "]+")) !== -1) ||
                 filename.match(_illegalFilenamesRegEx)) {
-            Dialogs.showModalDialog(
-                DefaultDialogs.DIALOG_ID_ERROR,
-                StringUtils.format(Strings.INVALID_FILENAME_TITLE, isFolder ? Strings.DIRECTORY_NAME : Strings.FILENAME),
-                StringUtils.format(Strings.INVALID_FILENAME_MESSAGE, isFolder ? Strings.DIRECTORY_NAMES_LEDE : Strings.FILENAMES_LEDE,  _invalidChars)
-            );
+            _showErrorDialog(ERR_TYPE_INVALID_FILENAME, isFolder, _invalidChars);
             return false;
         }
         return true;
@@ -1694,38 +1730,26 @@ define(function (require, exports, module) {
                     _createNode($baseDirNode, null, _entryToJSON(entry), true, true);
                 };
                 
-                var errorCallback = function (error, entry) {
-                    var titleType = isFolder ? Strings.DIRECTORY_NAME : Strings.FILENAME,
-                        entryType = isFolder ? Strings.DIRECTORY : Strings.FILE;
+                var errorCallback = function (error) {
                     if (error === FileSystemError.ALREADY_EXISTS) {
-                        Dialogs.showModalDialog(
-                            DefaultDialogs.DIALOG_ID_ERROR,
-                            StringUtils.format(Strings.INVALID_FILENAME_TITLE, titleType),
-                            StringUtils.format(Strings.ENTRY_WITH_SAME_NAME_EXISTS,
-                                StringUtils.breakableUrl(data.rslt.name))
-                        );
+                        _showErrorDialog(ERR_TYPE_CREATE_EXISTS, isFolder, null, data.rslt.name);
                     } else {
                         var errString = error === FileSystemError.NOT_WRITABLE ?
                                          Strings.NO_MODIFICATION_ALLOWED_ERR :
                                          StringUtils.format(Strings.GENERIC_ERROR, error);
 
-                        Dialogs.showModalDialog(
-                            DefaultDialogs.DIALOG_ID_ERROR,
-                            StringUtils.format(Strings.ERROR_CREATING_FILE_TITLE, entryType),
-                            StringUtils.format(Strings.ERROR_CREATING_FILE, entryType,
-                                StringUtils.breakableUrl(data.rslt.name), errString)
-                        );
+                        _showErrorDialog(ERR_TYPE_CREATE, isFolder, errString, data.rslt.name);
                     }
 
                     errorCleanup();
                 };
                 
                 var newItemPath = baseDirEntry.fullPath + data.rslt.name;
                 
-                FileSystem.resolve(newItemPath, function (err, item) {
+                FileSystem.resolve(newItemPath, function (err) {
                     if (!err) {
                         // Item already exists, fail with error
-                        errorCallback(FileSystemError.ALREADY_EXISTS, item);
+                        errorCallback(FileSystemError.ALREADY_EXISTS);
                     } else {
                         if (isFolder) {
                             var directory = FileSystem.getDirectoryForPath(newItemPath);
@@ -1820,17 +1844,11 @@ define(function (require, exports, module) {
                 result.resolve();
             } else {
                 // Show an error alert
-                Dialogs.showModalDialog(
-                    DefaultDialogs.DIALOG_ID_ERROR,
-                    Strings.ERROR_RENAMING_FILE_TITLE,
-                    StringUtils.format(
-                        Strings.ERROR_RENAMING_FILE,
-                        StringUtils.breakableUrl(newName),
-                        err === FileSystemError.ALREADY_EXISTS ?
+                var errString = err === FileSystemError.ALREADY_EXISTS ?
                                 Strings.FILE_EXISTS_ERR :
-                                FileUtils.getFileErrorString(err)
-                    )
-                );
+                                FileUtils.getFileErrorString(err);
+
+                _showErrorDialog(ERR_TYPE_RENAME, isFolder, errString, newName);
                 result.reject(err);
             }
         });
@@ -2005,16 +2023,7 @@ define(function (require, exports, module) {
                 _deleteTreeNode(entry);
                 result.resolve();
             } else {
-                // Show an error alert
-                Dialogs.showModalDialog(
-                    Dialogs.DIALOG_ID_ERROR,
-                    Strings.ERROR_DELETING_FILE_TITLE,
-                    StringUtils.format(
-                        Strings.ERROR_DELETING_FILE,
-                        _.escape(entry.fullPath),
-                        FileUtils.getFileErrorString(err)
-                    )
-                );
+                _showErrorDialog(ERR_TYPE_DELETE, entry.isDirectory, FileUtils.getFileErrorString(err), entry.fullPath);
     
                 result.reject(err);
             }
