FlutterModuleBuilder.java

/*
 * Copyright 2016 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.
 */
package io.flutter.module;

import static java.util.Arrays.asList;

import com.intellij.execution.OutputListener;
import com.intellij.execution.process.ProcessListener;
import com.intellij.ide.util.projectWizard.ModuleBuilder;
import com.intellij.ide.util.projectWizard.ModuleWizardStep;
import com.intellij.ide.util.projectWizard.SettingsStep;
import com.intellij.ide.util.projectWizard.WizardContext;
import com.intellij.openapi.Disposable;
import com.intellij.openapi.application.WriteAction;
import com.intellij.openapi.diagnostic.Logger;
import com.intellij.openapi.module.ModifiableModuleModel;
import com.intellij.openapi.module.Module;
import com.intellij.openapi.module.ModuleManager;
import com.intellij.openapi.module.ModuleType;
import com.intellij.openapi.module.ModuleWithNameAlreadyExists;
import com.intellij.openapi.options.ConfigurationException;
import com.intellij.openapi.progress.ProgressManager;
import com.intellij.openapi.project.Project;
import com.intellij.openapi.roots.ModifiableRootModel;
import com.intellij.openapi.ui.Messages;
import com.intellij.openapi.util.Disposer;
import com.intellij.openapi.util.text.StringUtil;
import com.intellij.openapi.vfs.LocalFileSystem;
import com.intellij.openapi.vfs.VirtualFile;
import icons.FlutterIcons;
import io.flutter.FlutterBundle;
import io.flutter.FlutterConstants;
import io.flutter.FlutterMessages;
import io.flutter.FlutterUtils;
import io.flutter.actions.FlutterDoctorAction;
import io.flutter.module.settings.FlutterCreateAdditionalSettingsFields;
import io.flutter.module.settings.SettingsHelpForm;
import io.flutter.pub.PubRoot;
import io.flutter.sdk.FlutterCreateAdditionalSettings;
import io.flutter.sdk.FlutterSdk;
import io.flutter.sdk.FlutterSdkUtil;
import io.flutter.utils.AndroidUtils;
import io.flutter.utils.FlutterModuleUtils;
import java.io.IOException;
import java.util.concurrent.atomic.AtomicReference;
import javax.swing.ComboBoxEditor;
import javax.swing.Icon;
import javax.swing.JComponent;
import org.apache.commons.lang.StringUtils;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

public class FlutterModuleBuilder extends ModuleBuilder {
  private static final Logger LOG = Logger.getInstance(FlutterModuleBuilder.class);

  protected FlutterModuleWizardStep myStep;
  private FlutterCreateAdditionalSettingsFields mySettingsFields;
  protected Project myProject;

  @Override
  public String getName() {
    return getPresentableName();
  }

  @Nullable
  public Project getProject() {
    return myProject; // Non-null when creating a module.
  }

  @Override
  public String getPresentableName() {
    return FlutterBundle.message("flutter.module.name");
  }

  @Override
  public String getDescription() {
    return FlutterBundle.message("flutter.project.description");
  }

  @Override
  public Icon getNodeIcon() {
    return FlutterIcons.Flutter;
  }

  @Override
  public void setupRootModel(@NotNull ModifiableRootModel model) {
    doAddContentEntry(model);
    // Add a reference to Dart SDK project library, without committing.
    model.addInvalidLibrary("Dart SDK", "project");
  }

  protected FlutterSdk getFlutterSdk() {
    return myStep.getFlutterSdk();
  }

  @Nullable
  @Override
  public Module commitModule(@NotNull Project project, @Nullable ModifiableModuleModel model) {
    final String basePath = getModuleFileDirectory();
    if (basePath == null) {
      Messages.showErrorDialog("Module path not set", "Internal Error");
      return null;
    }
    final VirtualFile baseDir = LocalFileSystem.getInstance().refreshAndFindFileByPath(basePath);
    if (baseDir == null) {
      Messages.showErrorDialog("Unable to determine Flutter project directory", "Internal Error");
      return null;
    }

    final FlutterSdk sdk = getFlutterSdk();
    if (sdk == null) {
      Messages.showErrorDialog("Flutter SDK not found", "Error");
      return null;
    }

    final OutputListener listener = new OutputListener();
    @NotNull FlutterCreateAdditionalSettings settings = getAdditionalSettings();
    final PubRoot root = runFlutterCreateWithProgress(baseDir, sdk, project, listener, settings);
    if (root == null) {
      final String stderr = listener.getOutput().getStderr();
      final String msg = stderr.isEmpty() ? "Flutter create command was unsuccessful" : stderr;
      final int code = FlutterMessages.showDialog(project, msg, "Project Creation Error", new String[]{"Run Flutter Doctor", "Cancel"}, 0);
      if (code == 0) {
        new FlutterDoctorAction().startCommand(project, sdk, null);
      }
      return null;
    }
    FlutterSdkUtil.updateKnownSdkPaths(sdk.getHomePath());

    // Create the Flutter module. This indirectly calls setupRootModule, etc.
    final Module flutter = super.commitModule(project, model);
    if (flutter == null) {
      return null;
    }

    FlutterModuleUtils.autoShowMain(project, root);

    if (!(AndroidUtils.isAndroidProject(getProject()) &&
          (settings.getType() == FlutterProjectType.MODULE))) {
      addAndroidModule(project, model, basePath, flutter.getName());
    }
    return flutter;
  }

  private String validateSettings(FlutterCreateAdditionalSettings settings) {
    final String description = settings.getDescription();
    if (description != null && description.contains(": ")) {
      return FlutterBundle.message("npw_invalid_desc_error");
    }
    final String org = settings.getOrg();
    if (org == null) {
      return null;
    }
    if (StringUtils.endsWith(org, ".")) {
      return FlutterBundle.message("npw_invalid_org_error");
    }
    if (mySettingsFields.isShowingPlatforms() && !settings.isSomePlatformSelected()) {
      return FlutterBundle.message("npw_none_selected_error");
    }
    // Invalid package names will cause issues down the line.
    return AndroidUtils.validateAndroidPackageName(org);
  }

  private static void addAndroidModule(@NotNull Project project,
                                       @Nullable ModifiableModuleModel model,
                                       @NotNull String baseDirPath,
                                       @NotNull String flutterModuleName) {
    final VirtualFile baseDir = LocalFileSystem.getInstance().refreshAndFindFileByPath(baseDirPath);
    if (baseDir == null) {
      return;
    }

    final VirtualFile androidFile = findAndroidModuleFile(baseDir, flutterModuleName);
    if (androidFile == null) return;

    try {
      final ModifiableModuleModel toCommit;
      if (model == null) {
        toCommit = ModuleManager.getInstance(project).getModifiableModel();
        //noinspection AssignmentToMethodParameter
        model = toCommit;
      }
      else {
        toCommit = null;
      }

      model.loadModule(androidFile.getPath());

      if (toCommit != null) {
        WriteAction.run(toCommit::commit);
      }
    }
    catch (ModuleWithNameAlreadyExists | IOException e) {
      FlutterUtils.warn(LOG, e);
    }
  }

  @Nullable
  private static VirtualFile findAndroidModuleFile(@NotNull VirtualFile baseDir, String flutterModuleName) {
    baseDir.refresh(false, false);
    for (String name : asList(flutterModuleName + "_android.iml", "android.iml")) {
      final VirtualFile candidate = baseDir.findChild(name);
      if (candidate != null && candidate.exists()) {
        return candidate;
      }
    }
    return null;
  }

  @Override
  public boolean validate(@Nullable Project current, @NotNull Project dest) {
    final String settingsValidation = validateSettings(getAdditionalSettings());
    if (settingsValidation != null) {
      Messages.showErrorDialog(settingsValidation, "Error");
      return false;
    }

    return myStep.getFlutterSdk() != null;
  }

  /**
   * @see <a href="dart.dev/tools/pub/pubspec#name">https://dart.dev/tools/pub/pubspec#name</a>
   */
  @Override
  public boolean validateModuleName(@NotNull String moduleName) throws ConfigurationException {
    if (!FlutterUtils.isValidPackageName(moduleName)) {
      throw new ConfigurationException(
        "Invalid module name: '" + moduleName + "' - must be a valid Dart package name (lower_case_with_underscores).");
    }

    if (FlutterUtils.isDartKeyword(moduleName)) {
      throw new ConfigurationException("Invalid module name: '" + moduleName + "' - must not be a Dart keyword.");
    }

    if (!FlutterUtils.isValidDartIdentifier(moduleName)) {
      throw new ConfigurationException("Invalid module name: '" + moduleName + "' - must be a valid Dart identifier.");
    }

    if (FlutterConstants.FLUTTER_PACKAGE_DEPENDENCIES.contains(moduleName)) {
      throw new ConfigurationException("Invalid module name: '" + moduleName + "' - this will conflict with Flutter package dependencies.");
    }

    if (moduleName.length() > FlutterConstants.MAX_MODULE_NAME_LENGTH) {
      throw new ConfigurationException("Invalid module name - must be less than " +
                                       FlutterConstants.MAX_MODULE_NAME_LENGTH +
                                       " characters.");
    }

    return super.validateModuleName(moduleName);
  }

  @NotNull
  public FlutterCreateAdditionalSettings getAdditionalSettings() {
    return mySettingsFields.getAdditionalSettings();
  }

  @Nullable
  @Override
  public ModuleWizardStep modifySettingsStep(@NotNull SettingsStep settingsStep) {
    final ModuleWizardStep wizard = super.modifySettingsStep(settingsStep);
    mySettingsFields.addSettingsFields(settingsStep);
    return wizard;
  }

  @Override
  public ModuleWizardStep modifyProjectTypeStep(@NotNull SettingsStep settingsStep) {
    // Don't allow super to add an SDK selection field (#2052).
    return null;
  }

  @Override
  public ModuleWizardStep getCustomOptionsStep(final WizardContext context, final Disposable parentDisposable) {
    if (!context.isCreatingNewProject()) {
      myProject = context.getProject();
    }
    myStep = new FlutterModuleWizardStep(context);
    mySettingsFields = new FlutterCreateAdditionalSettingsFields(new FlutterCreateAdditionalSettings(), this::getFlutterSdk);
    Disposer.register(parentDisposable, myStep);
    return myStep;
  }

  @Override
  public String getBuilderId() {
    // The builder id is used to distinguish between different builders with the same module type, see
    // com.intellij.ide.projectWizard.ProjectTypeStep for an example.
    return StringUtil.notNullize(super.getBuilderId()) + "_" + FlutterModuleBuilder.class.getCanonicalName();
  }

  @Override
  @NotNull
  public ModuleType<?> getModuleType() {
    return FlutterModuleUtils.getFlutterModuleType();
  }

  /**
   * Runs flutter create without showing a console, but with an indeterminate progress dialog.
   * <p>
   * Returns the PubRoot if successful.
   */
  @Nullable
  public static PubRoot runFlutterCreateWithProgress(@NotNull VirtualFile baseDir,
                                                     @NotNull FlutterSdk sdk,
                                                     @NotNull Project project,
                                                     @Nullable ProcessListener processListener,
                                                     @Nullable FlutterCreateAdditionalSettings additionalSettings) {
    final ProgressManager progress = ProgressManager.getInstance();
    final AtomicReference<PubRoot> result = new AtomicReference<>(null);

    FlutterUtils.disableGradleProjectMigrationNotification(project);

    progress.runProcessWithProgressSynchronously(() -> {
      progress.getProgressIndicator().setIndeterminate(true);
      result.set(sdk.createFiles(baseDir, null, processListener, additionalSettings));
    }, "Creating Flutter project", false, project);

    return result.get();
  }

  public void setFlutterSdkPath(String s) {
    final ComboBoxEditor combo = myStep.myPeer.getSdkEditor();
    combo.setItem(s);
  }

  FlutterCreateAdditionalSettingsFields getSettingsField() {
    return mySettingsFields;
  }

  public static class FlutterModuleWizardStep extends ModuleWizardStep implements Disposable {
    private final FlutterGeneratorPeer myPeer;

    public FlutterModuleWizardStep(@NotNull WizardContext context) {
      //TODO(pq): find a way to listen to wizard cancelation and propagate to peer.
      myPeer = new FlutterGeneratorPeer(context);
      if (!FlutterUtils.isAndroidStudio()) {
        myPeer.getHelpForm().showGettingStarted();
      }
    }

    public SettingsHelpForm getHelpForm() {
      return myPeer.getHelpForm();
    }

    @Override
    public JComponent getComponent() {
      return myPeer.getComponent();
    }

    @Override
    public void updateDataModel() {
    }

    @Override
    public boolean validate() {
      final boolean valid = myPeer.validate();
      if (valid) {
        myPeer.apply();
      }
      return valid;
    }

    @Override
    public void dispose() {
    }

    @Nullable
    FlutterSdk getFlutterSdk() {
      final String sdkPath = myPeer.getSdkComboPath();

      // Ensure the local filesystem has caught up to external processes (e.g., git clone).
      if (!sdkPath.isEmpty()) {
        try {
          LocalFileSystem
            .getInstance().refreshAndFindFileByPath(sdkPath);
        }
        catch (Throwable e) {
          // It's possible that the refresh will fail in which case we just want to trap and ignore.
        }
      }
      return FlutterSdk.forPath(sdkPath);
    }
  }
}