Warn user if DART_SDK does not match editor SDK

editor/tools/plugins/com.google.dart.tools.ui/src/com/google/dart/tools/ui/DartUIStartup.java

 /*
  * Copyright (c) 2012, the Dart project authors.
  * 
  * Licensed under the Eclipse Public License v1.0 (the "License"); you may not use this file except
  * in compliance with the License. You may obtain a copy of the License at
  * 
  * http://www.eclipse.org/legal/epl-v10.html
  * 
  * Unless required by applicable law or agreed to in writing, software distributed under the License
  * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
  * or implied. See the License for the specific language governing permissions and limitations under
  * the License.
  */
 package com.google.dart.tools.ui;
 
+import com.google.dart.engine.sdk.DirectoryBasedDartSdk;
 import com.google.dart.engine.utilities.instrumentation.Instrumentation;
 import com.google.dart.engine.utilities.instrumentation.InstrumentationBuilder;
 import com.google.dart.tools.core.CmdLineOptions;
 import com.google.dart.tools.core.DartCore;
 import com.google.dart.tools.core.DartCoreDebug;
 import com.google.dart.tools.core.instrumentation.InstrumentationLogger;
+import com.google.dart.tools.core.model.DartSdk;
 import com.google.dart.tools.core.model.DartSdkManager;
 import com.google.dart.tools.ui.feedback.FeedbackUtils;
 import com.google.dart.tools.ui.internal.text.editor.AutoSaveHelper;
 
 import org.eclipse.core.runtime.jobs.Job;
+import org.eclipse.jface.dialogs.MessageDialogWithToggle;
+import org.eclipse.jface.preference.IPreferenceStore;
+import org.eclipse.swt.widgets.Display;
+import org.eclipse.swt.widgets.Shell;
 import org.eclipse.ui.IStartup;
+import org.eclipse.ui.PlatformUI;
+import org.eclipse.ui.editors.text.EditorsUI;
 
 import java.io.File;
+import java.io.IOException;
 
 /**
  * This early startup class is called after the main workbench window opens, and is used to warm up
  * various bits of compiler infrastructure.
  */
 public class DartUIStartup implements IStartup {
 
   private static final String DART_INSTRUMENTATION_FLAGS_FILE_NAME = "dart_instrumentation_flags.txt";
 
   public static void cancelStartup() {
@@ skipping 17 matching lines @@
       CmdLineFileProcessor.process(CmdLineOptions.getOptions());
       instrumentation.metric("OpenInitialFilesAndFolders", "Complete");
 
       AutoSaveHelper.start();
       instrumentation.metric("AutoSaveHelperStart", "Complete");
 
       if (CmdLineOptions.getOptions().getMeasurePerformance()) {
         Job perfJob = new PerfJob();
         perfJob.schedule();
       }
+
+      warnIfSdkAndDartSdkEnvVarDoNotMatch();
+
     } catch (Throwable throwable) {
       // Catch any runtime exceptions that occur during warm up and log them.
       DartToolsPlugin.log("Exception occured during editor warmup", throwable);
     } finally {
       instrumentation.log();
     }
   }
 
   /**
    * Determine if the {@value #DART_INSTRUMENTATION_FLAGS_FILE_NAME} file exists in the user's dart
@@ skipping 24 matching lines @@
       instrumentation.metric("BuildDate", DartCore.getBuildDate());
       instrumentation.metric("BuildID", DartCore.getBuildId());
       instrumentation.metric("Version", DartCore.getVersion());
       instrumentation.metric("SDKVersion", DartSdkManager.getManager().getSdk().getSdkVersion());
       instrumentation.metric("OSVersion", FeedbackUtils.getOSName());
       instrumentation.metric("IsInstrumentationFlagFilePresent", IsInstrumentationFlagFilePresent());
     } finally {
       instrumentation.log();
     }
   }
+
+  /**
+   * If the DART_SDK environment variable is defined, then compare it with the current SDK path and
+   * warn the user if they don't match.
+   */
+  private void warnIfSdkAndDartSdkEnvVarDoNotMatch() {
+    final String doNotWarnKey = "do_not_warn_if_DART_SDK_does_not_match";
+
+    // Skip this check if tests are running or user told us to ignore this problem
+    if (CmdLineOptions.getOptions().getRunTests()) {
+      return;
+    }
+    IPreferenceStore store = EditorsUI.getPreferenceStore();
+    if (store.getBoolean(doNotWarnKey)) {
+      return;
+    }
+
+    // Get the DART_SDK
+    File dartSdkDir;
+    try {
+      String dartSdkPath = System.getenv(DirectoryBasedDartSdk.DART_SDK_ENVIRONMENT_VARIABLE_NAME);
+      if (dartSdkPath == null) {
+        return;
+      }
+      dartSdkDir = new File(dartSdkPath).getCanonicalFile();
+    } catch (Exception e) {
+      DartCore.logInformation("Failed to determine DART_SDK", e);
+      return;
+    }
+
+    // Compare with the Editor's SDK
+    final String msg;
+    if (!dartSdkDir.exists()) {
+      msg = Messages.format(DartUIMessages.DartSdkInvalid_doesNotExist, dartSdkDir.getPath());
+    } else {
+      DartSdk editorSdk = DartSdkManager.getManager().getSdk();
+      File editorSdkDir;
+      try {
+        editorSdkDir = editorSdk.getDirectory().getCanonicalFile();
+      } catch (IOException e) {
+        DartCore.logInformation("Failed to determine Editor SDK directory", e);
+        return;
+      }
+      if (!editorSdkDir.equals(dartSdkDir)) {
+        msg = Messages.format(
+            DartUIMessages.DartSdkInvalid_notEqual,
+            new String[] {dartSdkDir.getPath(), editorSdkDir.getPath()});
+      } else {
+        return;
+      }
+    }
+
+    Display.getDefault().asyncExec(new Runnable() {

[lukechurch, 2013/11/15 03:19:02]

We should instrument the fact that we've discovered an SDK version mismatch, and
report the two versions as metrics, and the full paths as data

+      @Override
+      public void run() {
+        Shell shell = PlatformUI.getWorkbench().getActiveWorkbenchWindow().getShell();
+        MessageDialogWithToggle toggleDialog = MessageDialogWithToggle.openWarning(
+            shell,
+            DartUIMessages.DartSdkInvalid_title,
+            msg,
+            DartUIMessages.DartSdkInvalid_dontShowAgain,
+            false,
+            null,
+            null);
+        EditorsUI.getPreferenceStore().setValue(doNotWarnKey, toggleDialog.getToggleState());
+      }
+    });
+  }
 }