From 08b03a29844c89c02c4e0f34889dc1ae8d4b8b5d Mon Sep 17 00:00:00 2001 From: Edwin Kempin Date: Fri, 14 Sep 2012 16:32:57 +0200 Subject: [PATCH] Make commands to download patch sets configurable For patch sets on the ChangeScreen different commands for downloading the patch sets are offered. For some installations not all commands are needed. Allow Gerrit administrators to configure which download commands should be offered. Bug: issue 548 Change-Id: Ida3e00f3b98e37280ecded2e25b20fc0a21abec0 Signed-off-by: Edwin Kempin --- Documentation/config-gerrit.txt | 34 +++++++- .../gerrit/common/data/GerritConfig.java | 10 +++ .../PatchSetComplexDisclosurePanel.java | 80 +++++++++++-------- .../gerrit/httpd/GerritConfigProvider.java | 11 +-- .../client/AccountGeneralPreferences.java | 2 +- ...dSchemeConfig.java => DownloadConfig.java} | 26 ++++-- 6 files changed, 116 insertions(+), 47 deletions(-) rename gerrit-server/src/main/java/com/google/gerrit/server/config/{DownloadSchemeConfig.java => DownloadConfig.java} (66%) diff --git a/Documentation/config-gerrit.txt b/Documentation/config-gerrit.txt index 523823d174..5e2cc1826b 100644 --- a/Documentation/config-gerrit.txt +++ b/Documentation/config-gerrit.txt @@ -1012,6 +1012,10 @@ Default is `30 seconds`. ---- [download] + command = checkout + command = cherry_pick + command = pull + command = format_patch scheme = ssh scheme = http scheme = anon_http @@ -1021,6 +1025,34 @@ Default is `30 seconds`. The download section configures the allowed download methods. +[[download.command]]download.command:: ++ +Commands that should be offered to download changes. ++ +Multiple commands are supported: ++ +* `checkout` ++ +Command to fetch and checkout the patch set. ++ +* `cherry_pick` ++ +Command to fetch the patch set and to cherry-pick it onto the current +commit. ++ +* `pull` ++ +Command to pull the patch set. ++ +* `format_patch` ++ +Command to fetch the patch set and to feed it into the `format-patch` +command. + ++ +If `download.command` is not specified, all download commands are +offered. + [[download.scheme]]download.scheme:: + Schemes that should be used to download changes. @@ -1053,7 +1085,7 @@ generally worked on with the repo multi-repository tool. This is not default, as not all instances will deploy repo. + -If download.scheme is not specified, SSH, HTTP and Anonymous HTTP +If `download.scheme` is not specified, SSH, HTTP and Anonymous HTTP downloads are allowed. [[gerrit]]Section gerrit diff --git a/gerrit-common/src/main/java/com/google/gerrit/common/data/GerritConfig.java b/gerrit-common/src/main/java/com/google/gerrit/common/data/GerritConfig.java index 84364563d8..7c16129c14 100644 --- a/gerrit-common/src/main/java/com/google/gerrit/common/data/GerritConfig.java +++ b/gerrit-common/src/main/java/com/google/gerrit/common/data/GerritConfig.java @@ -17,6 +17,7 @@ package com.google.gerrit.common.data; import com.google.gerrit.common.auth.openid.OpenIdProviderPattern; import com.google.gerrit.reviewdb.client.Account; import com.google.gerrit.reviewdb.client.Account.FieldName; +import com.google.gerrit.reviewdb.client.AccountGeneralPreferences.DownloadCommand; import com.google.gerrit.reviewdb.client.AccountGeneralPreferences.DownloadScheme; import com.google.gerrit.reviewdb.client.AuthType; import com.google.gerrit.reviewdb.client.Project; @@ -38,6 +39,7 @@ public class GerritConfig implements Cloneable { protected boolean allowRegisterNewEmail; protected AuthType authType; protected Set downloadSchemes; + protected Set downloadCommands; protected String gitDaemonUrl; protected String gitHttpUrl; protected String sshdAddress; @@ -114,6 +116,14 @@ public class GerritConfig implements Cloneable { downloadSchemes = s; } + public Set getDownloadCommands() { + return downloadCommands; + } + + public void setDownloadCommands(final Set downloadCommands) { + this.downloadCommands = downloadCommands; + } + public GitwebConfig getGitwebLink() { return gitweb; } diff --git a/gerrit-gwtui/src/main/java/com/google/gerrit/client/changes/PatchSetComplexDisclosurePanel.java b/gerrit-gwtui/src/main/java/com/google/gerrit/client/changes/PatchSetComplexDisclosurePanel.java index 77099ab669..7e314cc340 100644 --- a/gerrit-gwtui/src/main/java/com/google/gerrit/client/changes/PatchSetComplexDisclosurePanel.java +++ b/gerrit-gwtui/src/main/java/com/google/gerrit/client/changes/PatchSetComplexDisclosurePanel.java @@ -209,6 +209,7 @@ class PatchSetComplexDisclosurePanel extends ComplexDisclosurePanel final DownloadCommandPanel commands = new DownloadCommandPanel(); final DownloadUrlPanel urls = new DownloadUrlPanel(commands); final Set allowedSchemes = Gerrit.getConfig().getDownloadSchemes(); + final Set allowedCommands = Gerrit.getConfig().getDownloadCommands(); copyLabel.setStyleName(Gerrit.RESOURCES.css().downloadLinkCopyLabel()); @@ -323,39 +324,52 @@ class PatchSetComplexDisclosurePanel extends ComplexDisclosurePanel } if (!urls.isEmpty()) { - commands.add(new DownloadCommandLink(DownloadCommand.CHECKOUT, "checkout") { - @Override - void setCurrentUrl(DownloadUrlLink link) { - urls.setVisible(true); - copyLabel.setText("git fetch " + link.urlData - + " && git checkout FETCH_HEAD"); - } - }); - commands.add(new DownloadCommandLink(DownloadCommand.PULL, "pull") { - @Override - void setCurrentUrl(DownloadUrlLink link) { - urls.setVisible(true); - copyLabel.setText("git pull " + link.urlData); - } - }); - commands.add(new DownloadCommandLink(DownloadCommand.CHERRY_PICK, - "cherry-pick") { - @Override - void setCurrentUrl(DownloadUrlLink link) { - urls.setVisible(true); - copyLabel.setText("git fetch " + link.urlData - + " && git cherry-pick FETCH_HEAD"); - } - }); - commands.add(new DownloadCommandLink(DownloadCommand.FORMAT_PATCH, - "patch") { - @Override - void setCurrentUrl(DownloadUrlLink link) { - urls.setVisible(true); - copyLabel.setText("git fetch " + link.urlData - + " && git format-patch -1 --stdout FETCH_HEAD"); - } - }); + if (allowedCommands.contains(DownloadCommand.CHECKOUT) + || allowedCommands.contains(DownloadCommand.DEFAULT_DOWNLOADS)) { + commands.add(new DownloadCommandLink(DownloadCommand.CHECKOUT, + "checkout") { + @Override + void setCurrentUrl(DownloadUrlLink link) { + urls.setVisible(true); + copyLabel.setText("git fetch " + link.urlData + + " && git checkout FETCH_HEAD"); + } + }); + } + if (allowedCommands.contains(DownloadCommand.PULL) + || allowedCommands.contains(DownloadCommand.DEFAULT_DOWNLOADS)) { + commands.add(new DownloadCommandLink(DownloadCommand.PULL, "pull") { + @Override + void setCurrentUrl(DownloadUrlLink link) { + urls.setVisible(true); + copyLabel.setText("git pull " + link.urlData); + } + }); + } + if (allowedCommands.contains(DownloadCommand.CHERRY_PICK) + || allowedCommands.contains(DownloadCommand.DEFAULT_DOWNLOADS)) { + commands.add(new DownloadCommandLink(DownloadCommand.CHERRY_PICK, + "cherry-pick") { + @Override + void setCurrentUrl(DownloadUrlLink link) { + urls.setVisible(true); + copyLabel.setText("git fetch " + link.urlData + + " && git cherry-pick FETCH_HEAD"); + } + }); + } + if (allowedCommands.contains(DownloadCommand.FORMAT_PATCH) + || allowedCommands.contains(DownloadCommand.DEFAULT_DOWNLOADS)) { + commands.add(new DownloadCommandLink(DownloadCommand.FORMAT_PATCH, + "patch") { + @Override + void setCurrentUrl(DownloadUrlLink link) { + urls.setVisible(true); + copyLabel.setText("git fetch " + link.urlData + + " && git format-patch -1 --stdout FETCH_HEAD"); + } + }); + } } final FlowPanel fp = new FlowPanel(); diff --git a/gerrit-httpd/src/main/java/com/google/gerrit/httpd/GerritConfigProvider.java b/gerrit-httpd/src/main/java/com/google/gerrit/httpd/GerritConfigProvider.java index 2f09380dd8..c1f3ae4293 100644 --- a/gerrit-httpd/src/main/java/com/google/gerrit/httpd/GerritConfigProvider.java +++ b/gerrit-httpd/src/main/java/com/google/gerrit/httpd/GerritConfigProvider.java @@ -22,7 +22,7 @@ import com.google.gerrit.server.account.Realm; import com.google.gerrit.server.config.AllProjectsName; import com.google.gerrit.server.config.AnonymousCowardName; import com.google.gerrit.server.config.AuthConfig; -import com.google.gerrit.server.config.DownloadSchemeConfig; +import com.google.gerrit.server.config.DownloadConfig; import com.google.gerrit.server.config.GerritServerConfig; import com.google.gerrit.server.contact.ContactStore; import com.google.gerrit.server.mail.EmailSender; @@ -48,7 +48,7 @@ class GerritConfigProvider implements Provider { private final Realm realm; private final Config cfg; private final AuthConfig authConfig; - private final DownloadSchemeConfig schemeConfig; + private final DownloadConfig downloadConfig; private final GitWebConfig gitWebConfig; private final AllProjectsName wildProject; private final SshInfo sshInfo; @@ -63,12 +63,12 @@ class GerritConfigProvider implements Provider { GerritConfigProvider(final Realm r, @GerritServerConfig final Config gsc, final AuthConfig ac, final GitWebConfig gwc, final AllProjectsName wp, final SshInfo si, final ApprovalTypes at, final ContactStore cs, - final ServletContext sc, final DownloadSchemeConfig dc, + final ServletContext sc, final DownloadConfig dc, final @AnonymousCowardName String acn) { realm = r; cfg = gsc; authConfig = ac; - schemeConfig = dc; + downloadConfig = dc; gitWebConfig = gwc; sshInfo = si; wildProject = wp; @@ -111,7 +111,8 @@ class GerritConfigProvider implements Provider { config.setGitDaemonUrl(cfg.getString("gerrit", null, "canonicalgiturl")); config.setGitHttpUrl(cfg.getString("gerrit", null, "gitHttpUrl")); config.setUseContactInfo(contactStore != null && contactStore.isEnabled()); - config.setDownloadSchemes(schemeConfig.getDownloadScheme()); + config.setDownloadSchemes(downloadConfig.getDownloadSchemes()); + config.setDownloadCommands(downloadConfig.getDownloadCommands()); config.setAuthType(authConfig.getAuthType()); config.setWildProject(wildProject); config.setApprovalTypes(approvalTypes); diff --git a/gerrit-reviewdb/src/main/java/com/google/gerrit/reviewdb/client/AccountGeneralPreferences.java b/gerrit-reviewdb/src/main/java/com/google/gerrit/reviewdb/client/AccountGeneralPreferences.java index 185255c23f..6f121ee03a 100644 --- a/gerrit-reviewdb/src/main/java/com/google/gerrit/reviewdb/client/AccountGeneralPreferences.java +++ b/gerrit-reviewdb/src/main/java/com/google/gerrit/reviewdb/client/AccountGeneralPreferences.java @@ -32,7 +32,7 @@ public final class AccountGeneralPreferences { /** Preferred method to download a change. */ public static enum DownloadCommand { - REPO_DOWNLOAD, PULL, CHECKOUT, CHERRY_PICK, FORMAT_PATCH; + REPO_DOWNLOAD, PULL, CHECKOUT, CHERRY_PICK, FORMAT_PATCH, DEFAULT_DOWNLOADS; } public static enum DateFormat { diff --git a/gerrit-server/src/main/java/com/google/gerrit/server/config/DownloadSchemeConfig.java b/gerrit-server/src/main/java/com/google/gerrit/server/config/DownloadConfig.java similarity index 66% rename from gerrit-server/src/main/java/com/google/gerrit/server/config/DownloadSchemeConfig.java rename to gerrit-server/src/main/java/com/google/gerrit/server/config/DownloadConfig.java index ecfe4f56b2..f259871485 100644 --- a/gerrit-server/src/main/java/com/google/gerrit/server/config/DownloadSchemeConfig.java +++ b/gerrit-server/src/main/java/com/google/gerrit/server/config/DownloadConfig.java @@ -14,8 +14,9 @@ package com.google.gerrit.server.config; -import com.google.gerrit.reviewdb.client.SystemConfig; +import com.google.gerrit.reviewdb.client.AccountGeneralPreferences.DownloadCommand; import com.google.gerrit.reviewdb.client.AccountGeneralPreferences.DownloadScheme; +import com.google.gerrit.reviewdb.client.SystemConfig; import com.google.inject.Inject; import com.google.inject.Singleton; @@ -28,22 +29,33 @@ import java.util.Set; /** Download protocol from {@code gerrit.config}. */ @Singleton -public class DownloadSchemeConfig { +public class DownloadConfig { private final Set downloadSchemes; + private final Set downloadCommands; @Inject - DownloadSchemeConfig(@GerritServerConfig final Config cfg, + DownloadConfig(@GerritServerConfig final Config cfg, final SystemConfig s) { - List all = + List allSchemes = ConfigUtil.getEnumList(cfg, "download", null, "scheme", DownloadScheme.DEFAULT_DOWNLOADS); - downloadSchemes = - Collections.unmodifiableSet(new HashSet(all)); + Collections.unmodifiableSet(new HashSet(allSchemes)); + + List allCommands = + ConfigUtil.getEnumList(cfg, "download", null, "command", + DownloadCommand.DEFAULT_DOWNLOADS); + downloadCommands = + Collections.unmodifiableSet(new HashSet(allCommands)); } /** Scheme used to download. */ - public Set getDownloadScheme() { + public Set getDownloadSchemes() { return downloadSchemes; } + + /** Command used to download. */ + public Set getDownloadCommands() { + return downloadCommands; + } }