plugins/git4idea/src/git4idea/config/GitVcsSettings.java

   1 package git4idea.config;
   2 /*
   3  * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance
   4  * with the License. You may obtain a copy of the License at:
   5  *
   6  *   http://www.apache.org/licenses/LICENSE-2.0
   7  *
   8  * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed
   9  * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for
  10  * the specific language governing permissions and limitations under the License.
  11  *
  12  * Copyright 2007 Decentrix Inc
  13  * Copyright 2007 Aspiro AS
  14  * Copyright 2008 MQSoftware
  15  * Copyright 2008 JetBrains s.r.o.
  16  * Copyright 2000-2009 JetBrains s.r.o.
  17  *
  18  * Authors: gevession, Erlend Simonsen & Mark Scott
  19  *
  20  * This code was originally derived from the MKS & Mercurial IDEA VCS plugins
  21  */
  22
  23 import com.intellij.openapi.application.ApplicationManager;
  24 import com.intellij.openapi.components.PersistentStateComponent;
  25 import com.intellij.openapi.components.ServiceManager;
  26 import com.intellij.openapi.components.State;
  27 import com.intellij.openapi.components.Storage;
  28 import com.intellij.openapi.progress.ProcessCanceledException;
  29 import com.intellij.openapi.project.Project;
  30 import com.intellij.openapi.util.Computable;
  31 import com.intellij.openapi.util.SystemInfo;
  32 import com.intellij.util.xmlb.XmlSerializerUtil;
  33 import org.jetbrains.annotations.NonNls;
  34
  35 import java.io.File;
  36 import java.util.Arrays;
  37 import java.util.LinkedList;
  38
  39 /**
  40  * Git VCS settings
  41  */
  42 @State(
  43   name = "Git.Settings",
  44   storages = {@Storage(
  45     id = "ws",
  46     file = "$WORKSPACE_FILE$")})
  47 public class GitVcsSettings implements PersistentStateComponent<GitVcsSettings> {
  48   /**
  49    * Default SSH policy
  50    */
  51   private static final SshExecutable DEFAULT_SSH = SshExecutable.IDEA_SSH;
  52   /**
  53    * the default cygwin executable
  54    */
  55   @NonNls private static final String[] DEFAULT_WINDOWS_PATHS =
  56     {"C:\\cygwin\\bin", "C:\\Program Files\\Git\\bin", "C:\\Program Files (x86)\\Git\\bin"};
  57   /**
  58    * Windows executable name
  59    */
  60   @NonNls private static final String DEFAULT_WINDOWS_GIT = "git.exe";
  61   /**
  62    * Default UNIX paths
  63    */
  64   @NonNls private static final String[] DEFAULT_UNIX_PATHS = {"/usr/local/bin", "/usr/bin", "/opt/local/bin", "/opt/bin"};
  65   /**
  66    * UNIX executable name
  67    */
  68   @NonNls private static final String DEFAULT_UNIX_GIT = "git";
  69
  70   /**
  71    * The default executable for GIT
  72    */
  73   public String GIT_EXECUTABLE = defaultGit();
  74   /**
  75    * The previously entered authors of the commit (up to {@value #PREVIOUS_COMMIT_AUTHORS_LIMIT})
  76    */
  77   public String[] PREVIOUS_COMMIT_AUTHORS = {};
  78   /**
  79    * Limit for previous commit authors
  80    */
  81   public static final int PREVIOUS_COMMIT_AUTHORS_LIMIT = 16;
  82   /**
  83    * Checkout includes tags
  84    */
  85   public Boolean CHECKOUT_INCLUDE_TAGS;
  86   /**
  87    * IDEA SSH should be used instead of native SSH.
  88    */
  89   public SshExecutable SSH_EXECUTABLE = DEFAULT_SSH;
  90   /**
  91    * True if stash/unstash operation should be performed before update.
  92    */
  93   public boolean UPDATE_STASH = true;
  94   /**
  95    * The type of update operation to perform
  96    */
  97   public UpdateType UPDATE_TYPE = UpdateType.BRANCH_DEFAULT;
  98
  99   /**
 100    * Save an author of the commit and make it the first one. If amount of authors exceeds the limit, remove least recently selected author.
 101    *
 102    * @param author an author to save
 103    */
 104   public void saveCommitAuthor(String author) {
 105     LinkedList<String> authors = new LinkedList<String>(Arrays.asList(PREVIOUS_COMMIT_AUTHORS));
 106     authors.remove(author);
 107     while (authors.size() >= PREVIOUS_COMMIT_AUTHORS_LIMIT) {
 108       authors.removeLast();
 109     }
 110     authors.addFirst(author);
 111     PREVIOUS_COMMIT_AUTHORS = authors.toArray(new String[authors.size()]);
 112   }
 113
 114   /**
 115    * {@inheritDoc}
 116    */
 117   public GitVcsSettings getState() {
 118     return this;
 119   }
 120
 121   /**
 122    * {@inheritDoc}
 123    */
 124   public void loadState(GitVcsSettings gitVcsSettings) {
 125     XmlSerializerUtil.copyBean(gitVcsSettings, this);
 126   }
 127
 128   /**
 129    * Get git setting for the project
 130    *
 131    * @param project a context project
 132    * @return the git settings
 133    */
 134   public static GitVcsSettings getInstance(Project project) {
 135     return ServiceManager.getService(project, GitVcsSettings.class);
 136   }
 137
 138   /**
 139    * Get instance with checked read action
 140    *
 141    * @param project the project to get setting for
 142    * @return the settings object
 143    */
 144   public static GitVcsSettings getInstanceChecked(final Project project) {
 145     return ApplicationManager.getApplication().runReadAction(new Computable<GitVcsSettings>() {
 146       public GitVcsSettings compute() {
 147         if (project.isDisposed()) throw new ProcessCanceledException();
 148         return ServiceManager.getService(project, GitVcsSettings.class);
 149       }
 150     });
 151   }
 152
 153   /**
 154    * @return the default executable name depending on the platform
 155    */
 156   private static String defaultGit() {
 157     String[] paths;
 158     String program;
 159     if (SystemInfo.isWindows) {
 160       program = DEFAULT_WINDOWS_GIT;
 161       paths = DEFAULT_WINDOWS_PATHS;
 162     }
 163     else {
 164       program = DEFAULT_UNIX_GIT;
 165       paths = DEFAULT_UNIX_PATHS;
 166     }
 167     for (String p : paths) {
 168       File f = new File(p, program);
 169       if (f.exists()) {
 170         return f.getAbsolutePath();
 171       }
 172     }
 173     return program;     // otherwise, hope it's in $PATH
 174   }
 175
 176   /**
 177    * @return true if IDEA ssh should be used
 178    */
 179   public boolean isIdeaSsh() {
 180     return (SSH_EXECUTABLE == null ? DEFAULT_SSH : SSH_EXECUTABLE) == SshExecutable.IDEA_SSH;
 181   }
 182
 183   /**
 184    * @return true if IDEA ssh should be used
 185    */
 186   public static boolean isDefaultIdeaSsh() {
 187     return DEFAULT_SSH == SshExecutable.IDEA_SSH;
 188   }
 189
 190   /**
 191    * Set IDEA ssh value
 192    *
 193    * @param value the value to set
 194    */
 195   public void setIdeaSsh(boolean value) {
 196     SSH_EXECUTABLE = value ? SshExecutable.IDEA_SSH : SshExecutable.NATIVE_SSH;
 197   }
 198
 199   /**
 200    * Kinds of SSH executable to be used with the git
 201    */
 202   public enum SshExecutable {
 203     /**
 204      * SSH provided by IDEA
 205      */
 206     IDEA_SSH,
 207     /**
 208      * Naive SSH.
 209      */
 210     NATIVE_SSH, }
 211
 212   /**
 213    * The type of update to perform
 214    */
 215   public enum UpdateType {
 216     /** Use default specified in the config file for the branch */
 217     BRANCH_DEFAULT,
 218     /** Merge fetched commits with local branch */
 219     MERGE,
 220     /** Rebase local commits upon the fetched branch*/
 221     REBASE
 222   }
 223 }