Skip to content

Commit

Permalink
Per project settings
Browse files Browse the repository at this point in the history
  • Loading branch information
@reda-alaoui
reda-alaoui committed May 13, 2020
1 parent f6fb171 commit 0ea8199
Show file tree
Hide file tree
Showing 38 changed files with 904 additions and 531 deletions.
3 changes: 1 addition & 2 deletions src/main/java/com/urswolfer/intellij/plugin/gerrit/GerritModule.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,13 @@
import com.google.inject.Provider;
import com.google.inject.Singleton;
import com.intellij.openapi.components.ServiceManager;
import com.urswolfer.gerrit.client.rest.GerritAuthData;
import com.urswolfer.intellij.plugin.gerrit.extension.GerritCheckoutProvider;
import com.urswolfer.intellij.plugin.gerrit.extension.GerritHttpAuthDataProvider;
import com.urswolfer.intellij.plugin.gerrit.git.GerritGitUtil;
import com.urswolfer.intellij.plugin.gerrit.push.GerritPushExtension;
import com.urswolfer.intellij.plugin.gerrit.rest.GerritRestModule;
import com.urswolfer.intellij.plugin.gerrit.rest.GerritUtil;
import com.urswolfer.intellij.plugin.gerrit.settings.GerritSettings;
import com.urswolfer.intellij.plugin.gerrit.ui.GerritToolWindow;
import com.urswolfer.intellij.plugin.gerrit.ui.GerritUiModule;
import com.urswolfer.intellij.plugin.gerrit.ui.action.GerritActionsModule;
Expand Down Expand Up @@ -91,7 +91,6 @@ public GerritSettings get() {
}
};
bind(GerritSettings.class).toProvider(settingsProvider).in(Singleton.class);
bind(GerritAuthData.class).toProvider(settingsProvider).in(Singleton.class);
}

protected void installOpenIdeDependenciesModule() {
Expand Down
311 changes: 3 additions & 308 deletions src/main/java/com/urswolfer/intellij/plugin/gerrit/GerritSettings.java
View file
Original file line number Diff line number Diff line change
@@ -1,314 +1,9 @@
/*
* Copyright 2000-2012 JetBrains s.r.o.
* Copyright 2013 Urs Wolfer
*
* Licensed under the Apache License, Version 2.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.apache.org/licenses/LICENSE-2.0
*
* 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.urswolfer.intellij.plugin.gerrit;

import com.google.common.base.Optional;
import com.google.common.base.Strings;
import com.intellij.ide.passwordSafe.PasswordSafe;
import com.intellij.ide.passwordSafe.PasswordSafeException;
import com.intellij.openapi.application.ApplicationManager;
import com.intellij.openapi.components.PersistentStateComponent;
import com.intellij.openapi.components.State;
import com.intellij.openapi.components.Storage;
import com.intellij.openapi.diagnostic.Logger;
import com.intellij.openapi.ui.Messages;
import com.urswolfer.gerrit.client.rest.GerritAuthData;
import com.urswolfer.intellij.plugin.gerrit.ui.ShowProjectColumn;
import org.jdom.Element;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

import java.util.concurrent.atomic.AtomicInteger;

/**
* Parts based on org.jetbrains.plugins.github.GithubSettings
* Placeholder allowing to retrieve the legacy password.
*
* @author oleg
* @author Urs Wolfer
* @author Réda Housni Alaoui
*/
@State(name = "GerritSettings", storages = @Storage("gerrit_settings.xml"))
public class GerritSettings implements PersistentStateComponent<Element>, GerritAuthData {

private static final String GERRIT_SETTINGS_TAG = "GerritSettings";
private static final String LOGIN = "Login";
private static final String HOST = "Host";
private static final String AUTOMATIC_REFRESH = "AutomaticRefresh";
private static final String LIST_ALL_CHANGES = "ListAllChanges";
private static final String REFRESH_TIMEOUT = "RefreshTimeout";
private static final String REVIEW_NOTIFICATIONS = "ReviewNotifications";
private static final String PUSH_TO_GERRIT = "PushToGerrit";
private static final String SHOW_CHANGE_NUMBER_COLUMN = "ShowChangeNumberColumn";
private static final String SHOW_CHANGE_ID_COLUMN = "ShowChangeIdColumn";
private static final String SHOW_TOPIC_COLUMN = "ShowTopicColumn";
private static final String SHOW_PROJECT_COLUMN = "ShowProjectColumn";
private static final String CLONE_BASE_URL = "CloneBaseUrl";
private static final String GERRIT_SETTINGS_PASSWORD_KEY = "GERRIT_SETTINGS_PASSWORD_KEY";

private String login = "";
private String host = "";
private boolean listAllChanges = false;
private boolean automaticRefresh = true;
private int refreshTimeout = 15;
private boolean refreshNotifications = true;
private boolean pushToGerrit = false;
private boolean showChangeNumberColumn = false;
private boolean showChangeIdColumn = false;
private boolean showTopicColumn = false;
private ShowProjectColumn showProjectColumn = ShowProjectColumn.AUTO;
private String cloneBaseUrl = "";

private Optional<String> preloadedPassword;
private AtomicInteger passwordDialogShowLimit = new AtomicInteger(3);

private Logger log;

public Element getState() {
final Element element = new Element(GERRIT_SETTINGS_TAG);
element.setAttribute(LOGIN, (getLogin() != null ? getLogin() : ""));
element.setAttribute(HOST, (getHost() != null ? getHost() : ""));
element.setAttribute(LIST_ALL_CHANGES, Boolean.toString(getListAllChanges()));
element.setAttribute(AUTOMATIC_REFRESH, Boolean.toString(getAutomaticRefresh()));
element.setAttribute(REFRESH_TIMEOUT, Integer.toString(getRefreshTimeout()));
element.setAttribute(REVIEW_NOTIFICATIONS, Boolean.toString(getReviewNotifications()));
element.setAttribute(PUSH_TO_GERRIT, Boolean.toString(getPushToGerrit()));
element.setAttribute(SHOW_CHANGE_NUMBER_COLUMN, Boolean.toString(getShowChangeNumberColumn()));
element.setAttribute(SHOW_CHANGE_ID_COLUMN, Boolean.toString(getShowChangeIdColumn()));
element.setAttribute(SHOW_TOPIC_COLUMN, Boolean.toString(getShowTopicColumn()));
element.setAttribute(SHOW_PROJECT_COLUMN, getShowProjectColumn().name());
element.setAttribute(CLONE_BASE_URL, (getCloneBaseUrl() != null ? getCloneBaseUrl() : ""));
return element;
}

public void loadState(@NotNull final Element element) {
// All the logic on retrieving password was moved to getPassword action to cleanup initialization process
try {
setLogin(element.getAttributeValue(LOGIN));
setHost(element.getAttributeValue(HOST));

setListAllChanges(getBooleanValue(element, LIST_ALL_CHANGES));
setAutomaticRefresh(getBooleanValue(element, AUTOMATIC_REFRESH));
setRefreshTimeout(getIntegerValue(element, REFRESH_TIMEOUT));
setReviewNotifications(getBooleanValue(element, REVIEW_NOTIFICATIONS));
setPushToGerrit(getBooleanValue(element, PUSH_TO_GERRIT));
setShowChangeNumberColumn(getBooleanValue(element, SHOW_CHANGE_NUMBER_COLUMN));
setShowChangeIdColumn(getBooleanValue(element, SHOW_CHANGE_ID_COLUMN));
setShowTopicColumn(getBooleanValue(element, SHOW_TOPIC_COLUMN));
setShowProjectColumn(getShowProjectColumnValue(element, SHOW_PROJECT_COLUMN));
setCloneBaseUrl(element.getAttributeValue(CLONE_BASE_URL));
} catch (Exception e) {
log.error("Error happened while loading gerrit settings: " + e);
}
}

private boolean getBooleanValue(Element element, String attributeName) {
String attributeValue = element.getAttributeValue(attributeName);
if (attributeValue != null) {
return Boolean.valueOf(attributeValue);
} else {
return false;
}
}

private int getIntegerValue(Element element, String attributeName) {
String attributeValue = element.getAttributeValue(attributeName);
if (attributeValue != null) {
return Integer.valueOf(attributeValue);
} else {
return 0;
}
}

private ShowProjectColumn getShowProjectColumnValue(Element element, String attributeName) {
String attributeValue = element.getAttributeValue(attributeName);
if (attributeValue != null) {
return ShowProjectColumn.valueOf(attributeValue);
} else {
return ShowProjectColumn.AUTO;
}
}

@Override
@Nullable
public String getLogin() {
return login;
}

@Override
@NotNull
public String getPassword() {
if (!ApplicationManager.getApplication().isDispatchThread()) {
if (preloadedPassword == null) {
throw new IllegalStateException("Need to call #preloadPassword when password is required in background thread");
}
} else {
if (!preloadPassword()) {
return "";
}
}
return preloadedPassword.or("");
}

public boolean preloadPassword() {
String password = null;
try {
password = PasswordSafe.getInstance().getPassword(null, GerritSettings.class, GERRIT_SETTINGS_PASSWORD_KEY);
} catch (PasswordSafeException e) {
log.info("Couldn't get password for key [" + GERRIT_SETTINGS_PASSWORD_KEY + "]", e);
}
if (Strings.isNullOrEmpty(password) && !Strings.isNullOrEmpty(getLogin())) {
if (passwordDialogShowLimit.decrementAndGet() <= 0) {
return false;
}
password = Messages.showPasswordDialog(
String.format("Password for accessing Gerrit required (Login: %s, URL: %s).", getLogin(), getHost()),
"Gerrit Password");
if (password == null) {
return false;
}
}
preloadedPassword = Optional.fromNullable(password);
return true;
}

@Override
public boolean isHttpPassword() {
return false;
}

@Override
public String getHost() {
return host;
}

@Override
public boolean isLoginAndPasswordAvailable() {
return !Strings.isNullOrEmpty(getLogin());
}

public boolean getListAllChanges() {
return listAllChanges;
}

public void setListAllChanges(boolean listAllChanges) {
this.listAllChanges = listAllChanges;
}

public boolean getAutomaticRefresh() {
return automaticRefresh;
}

public int getRefreshTimeout() {
return refreshTimeout;
}

public boolean getReviewNotifications() {
return refreshNotifications;
}

public void setLogin(final String login) {
this.login = login != null ? login : "";
}

public void setPassword(final String password) {
try {
PasswordSafe.getInstance().storePassword(null, GerritSettings.class, GERRIT_SETTINGS_PASSWORD_KEY, password != null ? password : "");
} catch (PasswordSafeException e) {
log.info("Couldn't set password for key [" + GERRIT_SETTINGS_PASSWORD_KEY + "]", e);
}
}

public void forgetPassword() {
try {
PasswordSafe.getInstance().removePassword(null, GerritSettings.class, GERRIT_SETTINGS_PASSWORD_KEY);
} catch (PasswordSafeException e) {
log.info("Couldn't forget password for key [" + GERRIT_SETTINGS_PASSWORD_KEY + "]", e);
}
}

public void setHost(final String host) {
this.host = host;
}

public void setAutomaticRefresh(final boolean automaticRefresh) {
this.automaticRefresh = automaticRefresh;
}

public void setRefreshTimeout(final int refreshTimeout) {
this.refreshTimeout = refreshTimeout;
}

public void setReviewNotifications(final boolean reviewNotifications) {
refreshNotifications = reviewNotifications;
}

public void setPushToGerrit(boolean pushToGerrit) {
this.pushToGerrit = pushToGerrit;
}

public boolean getPushToGerrit() {
return pushToGerrit;
}

public boolean getShowChangeNumberColumn() {
return showChangeNumberColumn;
}

public void setShowChangeNumberColumn(boolean showChangeNumberColumn) {
this.showChangeNumberColumn = showChangeNumberColumn;
}

public boolean getShowChangeIdColumn() {
return showChangeIdColumn;
}

public void setShowChangeIdColumn(boolean showChangeIdColumn) {
this.showChangeIdColumn = showChangeIdColumn;
}

public boolean getShowTopicColumn() {
return showTopicColumn;
}

public ShowProjectColumn getShowProjectColumn() {
return showProjectColumn;
}

public void setShowProjectColumn(ShowProjectColumn showProjectColumn) {
this.showProjectColumn = showProjectColumn;
}

public void setShowTopicColumn(boolean showTopicColumn) {
this.showTopicColumn = showTopicColumn;
}

public void setCloneBaseUrl(String cloneBaseUrl) {
this.cloneBaseUrl = cloneBaseUrl;
}

public String getCloneBaseUrl() {
return cloneBaseUrl;
}

public void setLog(Logger log) {
this.log = log;
}

public String getCloneBaseUrlOrHost() {
return Strings.isNullOrEmpty(cloneBaseUrl) ? host : cloneBaseUrl;
}
public interface GerritSettings {
}
Loading

0 comments on commit 0ea8199

Please sign in to comment.