dart/editor/tools/plugins/com.google.dart.tools.ui/src/com/google/dart/tools/internal/corext/refactoring/rename/RenameProjectParticipant.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.internal.corext.refactoring.rename;

import com.google.dart.tools.core.DartCore;
import com.google.dart.tools.core.DartCoreDebug;
import com.google.dart.tools.core.pub.PubspecModel;
import com.google.dart.tools.core.utilities.io.FileUtilities;
import com.google.dart.tools.core.utilities.io.FilenameUtils;
import com.google.dart.tools.internal.corext.refactoring.util.ExecutionUtils;
import com.google.dart.tools.internal.corext.refactoring.util.RunnableObjectEx;
import com.google.dart.tools.ui.internal.refactoring.RefactoringMessages;
import com.google.dart.tools.ui.internal.refactoring.ServerMoveFileRefactoring;

import org.eclipse.core.resources.IFile;
import org.eclipse.core.resources.IProject;
import org.eclipse.core.resources.IProjectDescription;
import org.eclipse.core.resources.IResource;
import org.eclipse.core.resources.ResourcesPlugin;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IPath;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.OperationCanceledException;
import org.eclipse.ltk.core.refactoring.Change;
import org.eclipse.ltk.core.refactoring.RefactoringStatus;
import org.eclipse.ltk.core.refactoring.participants.CheckConditionsContext;
import org.eclipse.ltk.core.refactoring.participants.RenameArguments;
import org.eclipse.ltk.core.refactoring.participants.RenameParticipant;
import org.eclipse.ltk.core.refactoring.resource.ResourceChange;

import java.io.File;
import java.io.InputStreamReader;
import java.io.Reader;
import java.net.URL;

/**
 * {@link RenameParticipant} for renaming {@link IProject} folder on disk.
 * 
 * @coverage dart.editor.ui.refactoring.core
 */
public class RenameProjectParticipant extends RenameParticipant {

  private static final class RenameProjectFolderChange extends ResourceChange {
    private final IProject project;
    private final String newName;

    public RenameProjectFolderChange(IProject project, String newName) {
      this.project = project;
      this.newName = newName;
    }

    @Override
    public String getName() {
      return "Rename project folder on disk";
    }

    @Override
    public Change perform(IProgressMonitor pm) throws CoreException {
      try {
        // "project" was already renamed at this point
        IProject project = ResourcesPlugin.getWorkspace().getRoot().getProject(newName);
        IProjectDescription description = project.getDescription();
        // prepare locations
        File currentFile = toFile(description.getLocationURI().toURL());
        File newFile = new File(currentFile.getParentFile(), newName);
        // point project to this new folder
        {
          description.setLocationURI(newFile.toURI());
          project.move(description, IResource.FORCE | IResource.SHALLOW, pm);
        }
        // rename folder on disk
        currentFile.renameTo(newFile);
        // rename pubspec if necessary
        renamePubSpec(project);
      } catch (Throwable e) {
        DartCore.logError(e);
        return null;
      }
      return null;
    }

    @Override
    protected IResource getModifiedResource() {
      return project;
    }

    private void renamePubSpec(IProject newProject) {
      // Analysis Server will return the required change.
      if (DartCoreDebug.ENABLE_ANALYSIS_SERVER) {
        return;
      }
      // do rename
      IFile pubspec = newProject.getFile(DartCore.PUBSPEC_FILE_NAME);
      if (pubspec != null) {
        try {
          Reader reader = new InputStreamReader(pubspec.getContents(), pubspec.getCharset());
          PubspecModel model = new PubspecModel(pubspec, FileUtilities.getContents(reader));
          model.setName(newName);
          model.save();
        } catch (Exception e) {
        }
      }
    }
  }

  private static File toFile(URL url) {
    if (url == null || !url.getProtocol().equals("file")) {
      return null;
    } else {
      String filename = url.getFile().replace('/', File.separatorChar);
      int pos = 0;
      while ((pos = filename.indexOf('%', pos)) >= 0) {
        if (pos + 2 < filename.length()) {
          String hexStr = filename.substring(pos + 1, pos + 3);
          char ch = (char) Integer.parseInt(hexStr, 16);
          filename = filename.substring(0, pos) + ch + filename.substring(pos + 3);
        }
      }
      return new File(filename);
    }
  }

  private IProject project;

  @Override
  public RefactoringStatus checkConditions(IProgressMonitor pm, CheckConditionsContext context)
      throws OperationCanceledException {
    return new RefactoringStatus();
  }

  @Override
  public Change createChange(IProgressMonitor pm) {
    RenameArguments arguments = getArguments();
    String newName = arguments.getNewName();
    return new RenameProjectFolderChange(project, newName);
  }

  @Override
  public Change createPreChange(final IProgressMonitor pm) throws CoreException,
      OperationCanceledException {
    return ExecutionUtils.runObjectCore(new RunnableObjectEx<Change>() {
      @Override
      public Change runObject() throws Exception {
        return createPreChangeEx(pm);
      }
    });
  }

  @Override
  public String getName() {
    return RefactoringMessages.RenameResourceParticipant_name;
  }

  @Override
  protected boolean initialize(Object element) {
    if (element instanceof IProject) {
      project = (IProject) element;
      return true;
    }
    return false;
  }

  /**
   * Implementation of {@link #createPreChangeEx(IProgressMonitor)} which can throw any exception.
   */
  private Change createPreChangeEx(IProgressMonitor pm) throws Exception {
    if (DartCoreDebug.ENABLE_ANALYSIS_SERVER) {
      try {
        RenameArguments arguments = getArguments();
        IPath fileLocation = project.getLocation();
        String oldFile = fileLocation.toOSString();
        String oldDir = fileLocation.removeLastSegments(1).toOSString();
        String newName = arguments.getNewName();
        String newFile = FilenameUtils.concat(oldDir, newName);
        ServerMoveFileRefactoring refactoring = new ServerMoveFileRefactoring(oldFile);
        refactoring.setNewFile(newFile);
        if (refactoring.checkAllConditions(pm).hasError()) {
          return null;
        }
        return refactoring.createChange(pm);
      } catch (Throwable e) {
        return null;
      }
    } else {
      return null;
    }
  }
}