Implement standard download schemes and commands
Implement the standard download schemes and commands that are
currently hard-coded in Gerrit code in a plugin.
Change-Id: Icec3a8664f1fe4e18b0908ef47f39ba134890eba
Signed-off-by: Edwin Kempin <edwin.kempin@sap.com>
Signed-off-by: David Pursehouse <david.pursehouse@sonymobile.com>
diff --git a/BUCK b/BUCK
new file mode 100644
index 0000000..21043f8
--- /dev/null
+++ b/BUCK
@@ -0,0 +1,8 @@
+gerrit_plugin(
+ name = 'download-commands',
+ srcs = glob(['src/main/java/**/*.java']),
+ resources = glob(['src/main/resources/**/*']),
+ manifest_entries = [
+ 'Gerrit-Module: com.googlesource.gerrit.plugins.download.Module'
+ ]
+)
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..11069ed
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,201 @@
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+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.
diff --git a/src/main/java/com/googlesource/gerrit/plugins/download/Module.java b/src/main/java/com/googlesource/gerrit/plugins/download/Module.java
new file mode 100644
index 0000000..b578a51
--- /dev/null
+++ b/src/main/java/com/googlesource/gerrit/plugins/download/Module.java
@@ -0,0 +1,50 @@
+// Copyright (C) 2013 The Android Open Source Project
+//
+// 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.googlesource.gerrit.plugins.download;
+
+import com.google.gerrit.extensions.config.DownloadCommand;
+import com.google.gerrit.extensions.config.DownloadScheme;
+import com.google.gerrit.extensions.registration.DynamicSet;
+import com.google.inject.AbstractModule;
+
+import com.googlesource.gerrit.plugins.download.command.CheckoutCommand;
+import com.googlesource.gerrit.plugins.download.command.CherryPickCommand;
+import com.googlesource.gerrit.plugins.download.command.CloneCommand;
+import com.googlesource.gerrit.plugins.download.command.FormatPatchCommand;
+import com.googlesource.gerrit.plugins.download.command.PullCommand;
+import com.googlesource.gerrit.plugins.download.command.RepoCommand;
+import com.googlesource.gerrit.plugins.download.scheme.AnonymousGitScheme;
+import com.googlesource.gerrit.plugins.download.scheme.AnonymousHttpScheme;
+import com.googlesource.gerrit.plugins.download.scheme.HttpScheme;
+import com.googlesource.gerrit.plugins.download.scheme.RepoScheme;
+import com.googlesource.gerrit.plugins.download.scheme.SshScheme;
+
+class Module extends AbstractModule {
+ @Override
+ protected void configure() {
+ DynamicSet.bind(binder(), DownloadScheme.class).to(AnonymousHttpScheme.class);
+ DynamicSet.bind(binder(), DownloadScheme.class).to(AnonymousGitScheme.class);
+ DynamicSet.bind(binder(), DownloadScheme.class).to(HttpScheme.class);
+ DynamicSet.bind(binder(), DownloadScheme.class).to(RepoScheme.class);
+ DynamicSet.bind(binder(), DownloadScheme.class).to(SshScheme.class);
+
+ DynamicSet.bind(binder(), DownloadCommand.class).to(CloneCommand.class);
+ DynamicSet.bind(binder(), DownloadCommand.class).to(CheckoutCommand.class);
+ DynamicSet.bind(binder(), DownloadCommand.class).to(CherryPickCommand.class);
+ DynamicSet.bind(binder(), DownloadCommand.class).to(FormatPatchCommand.class);
+ DynamicSet.bind(binder(), DownloadCommand.class).to(PullCommand.class);
+ DynamicSet.bind(binder(), DownloadCommand.class).to(RepoCommand.class);
+ }
+}
diff --git a/src/main/java/com/googlesource/gerrit/plugins/download/command/CheckoutCommand.java b/src/main/java/com/googlesource/gerrit/plugins/download/command/CheckoutCommand.java
new file mode 100644
index 0000000..7507556
--- /dev/null
+++ b/src/main/java/com/googlesource/gerrit/plugins/download/command/CheckoutCommand.java
@@ -0,0 +1,32 @@
+// Copyright (C) 2013 The Android Open Source Project
+//
+// 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.googlesource.gerrit.plugins.download.command;
+
+import com.google.gerrit.extensions.annotations.Listen;
+import com.google.gerrit.server.config.DownloadConfig;
+import com.google.inject.Inject;
+
+@Listen
+public class CheckoutCommand extends GitDownloadCommand {
+ @Inject
+ CheckoutCommand(DownloadConfig downloadConfig) {
+ super(downloadConfig, com.google.gerrit.reviewdb.client.AccountGeneralPreferences.DownloadCommand.CHECKOUT);
+ }
+
+ @Override
+ public String getCommand(String url) {
+ return "git fetch " + url + " ${ref} && git checkout FETCH_HEAD";
+ }
+}
diff --git a/src/main/java/com/googlesource/gerrit/plugins/download/command/CherryPickCommand.java b/src/main/java/com/googlesource/gerrit/plugins/download/command/CherryPickCommand.java
new file mode 100644
index 0000000..6e46c22
--- /dev/null
+++ b/src/main/java/com/googlesource/gerrit/plugins/download/command/CherryPickCommand.java
@@ -0,0 +1,32 @@
+// Copyright (C) 2013 The Android Open Source Project
+//
+// 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.googlesource.gerrit.plugins.download.command;
+
+import com.google.gerrit.extensions.annotations.Listen;
+import com.google.gerrit.server.config.DownloadConfig;
+import com.google.inject.Inject;
+
+@Listen
+public class CherryPickCommand extends GitDownloadCommand {
+ @Inject
+ CherryPickCommand(DownloadConfig downloadConfig) {
+ super(downloadConfig, com.google.gerrit.reviewdb.client.AccountGeneralPreferences.DownloadCommand.CHERRY_PICK);
+ }
+
+ @Override
+ public String getCommand(String url) {
+ return "git fetch " + url + " ${ref} && git cherry-pick FETCH_HEAD";
+ }
+}
diff --git a/src/main/java/com/googlesource/gerrit/plugins/download/command/CloneCommand.java b/src/main/java/com/googlesource/gerrit/plugins/download/command/CloneCommand.java
new file mode 100644
index 0000000..7a67155
--- /dev/null
+++ b/src/main/java/com/googlesource/gerrit/plugins/download/command/CloneCommand.java
@@ -0,0 +1,37 @@
+// Copyright (C) 2013 The Android Open Source Project
+//
+// 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.googlesource.gerrit.plugins.download.command;
+
+import com.google.gerrit.extensions.annotations.Listen;
+import com.google.gerrit.server.config.DownloadConfig;
+import com.google.inject.Inject;
+
+@Listen
+public class CloneCommand extends GitDownloadCommand {
+ @Inject
+ CloneCommand(DownloadConfig downloadConfig) {
+ super(downloadConfig, com.google.gerrit.reviewdb.client.AccountGeneralPreferences.DownloadCommand.CHECKOUT);
+ }
+
+ @Override
+ public String getName() {
+ return "clone";
+ }
+
+ @Override
+ public String getCommand(String url) {
+ return "git clone " + url;
+ }
+}
diff --git a/src/main/java/com/googlesource/gerrit/plugins/download/command/FormatPatchCommand.java b/src/main/java/com/googlesource/gerrit/plugins/download/command/FormatPatchCommand.java
new file mode 100644
index 0000000..a216b32
--- /dev/null
+++ b/src/main/java/com/googlesource/gerrit/plugins/download/command/FormatPatchCommand.java
@@ -0,0 +1,32 @@
+// Copyright (C) 2013 The Android Open Source Project
+//
+// 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.googlesource.gerrit.plugins.download.command;
+
+import com.google.gerrit.extensions.annotations.Listen;
+import com.google.gerrit.server.config.DownloadConfig;
+import com.google.inject.Inject;
+
+@Listen
+public class FormatPatchCommand extends GitDownloadCommand {
+ @Inject
+ FormatPatchCommand(DownloadConfig downloadConfig) {
+ super(downloadConfig, com.google.gerrit.reviewdb.client.AccountGeneralPreferences.DownloadCommand.FORMAT_PATCH);
+ }
+
+ @Override
+ public String getCommand(String url) {
+ return "git fetch " + url + " ${ref} && git format-patch -1 --stdout FETCH_HEAD";
+ }
+}
diff --git a/src/main/java/com/googlesource/gerrit/plugins/download/command/GitDownloadCommand.java b/src/main/java/com/googlesource/gerrit/plugins/download/command/GitDownloadCommand.java
new file mode 100644
index 0000000..afad888
--- /dev/null
+++ b/src/main/java/com/googlesource/gerrit/plugins/download/command/GitDownloadCommand.java
@@ -0,0 +1,62 @@
+package com.googlesource.gerrit.plugins.download.command;
+
+import com.google.gerrit.extensions.config.DownloadCommand;
+import com.google.gerrit.extensions.config.DownloadScheme;
+import com.google.gerrit.server.config.DownloadConfig;
+
+import com.googlesource.gerrit.plugins.download.scheme.AnonymousGitScheme;
+import com.googlesource.gerrit.plugins.download.scheme.AnonymousHttpScheme;
+import com.googlesource.gerrit.plugins.download.scheme.HttpScheme;
+import com.googlesource.gerrit.plugins.download.scheme.SshScheme;
+
+public abstract class GitDownloadCommand extends DownloadCommand {
+ private final com.google.gerrit.reviewdb.client.AccountGeneralPreferences.DownloadCommand cmd;
+ private final boolean commandAllowed;
+
+ GitDownloadCommand(
+ DownloadConfig downloadConfig,
+ com.google.gerrit.reviewdb.client.AccountGeneralPreferences.DownloadCommand cmd) {
+ this.cmd = cmd;
+ this.commandAllowed = downloadConfig.getDownloadCommands().contains(cmd)
+ || downloadConfig.getDownloadCommands().contains(
+ com.google.gerrit.reviewdb.client.AccountGeneralPreferences.DownloadCommand.DEFAULT_DOWNLOADS);
+ }
+
+ @Override
+ public String getName() {
+ return upperUnderscoreToUpperHyphen(cmd.name());
+ }
+
+ /** Converts UPPER_UNDERSCORE to Upper-Hyphen */
+ private static String upperUnderscoreToUpperHyphen(String upperUnderscore) {
+ StringBuilder upperHyphen = new StringBuilder(upperUnderscore.length());
+ String[] words = upperUnderscore.split("_");
+ for (int i = 0, l = words.length; i < l; ++i) {
+ if (i > 0) {
+ upperHyphen.append("-");
+ }
+ upperHyphen.append(Character.toUpperCase(words[i].charAt(0))).append(
+ words[i].substring(1).toLowerCase());
+
+ }
+ return upperHyphen.toString();
+ }
+
+ @Override
+ public final String getCommand(DownloadScheme scheme, String project) {
+ if (!commandAllowed) {
+ return null;
+ }
+
+ if (scheme instanceof SshScheme
+ || scheme instanceof HttpScheme
+ || scheme instanceof AnonymousHttpScheme
+ || scheme instanceof AnonymousGitScheme) {
+ return getCommand(scheme.getUrl(project));
+ } else {
+ return null;
+ }
+ }
+
+ public abstract String getCommand(String url);
+}
diff --git a/src/main/java/com/googlesource/gerrit/plugins/download/command/PullCommand.java b/src/main/java/com/googlesource/gerrit/plugins/download/command/PullCommand.java
new file mode 100644
index 0000000..b071779
--- /dev/null
+++ b/src/main/java/com/googlesource/gerrit/plugins/download/command/PullCommand.java
@@ -0,0 +1,32 @@
+// Copyright (C) 2013 The Android Open Source Project
+//
+// 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.googlesource.gerrit.plugins.download.command;
+
+import com.google.gerrit.extensions.annotations.Listen;
+import com.google.gerrit.server.config.DownloadConfig;
+import com.google.inject.Inject;
+
+@Listen
+public class PullCommand extends GitDownloadCommand {
+ @Inject
+ PullCommand(DownloadConfig downloadConfig) {
+ super(downloadConfig, com.google.gerrit.reviewdb.client.AccountGeneralPreferences.DownloadCommand.PULL);
+ }
+
+ @Override
+ public String getCommand(String url) {
+ return "git pull " + url + " ${ref}";
+ }
+}
diff --git a/src/main/java/com/googlesource/gerrit/plugins/download/command/RepoCommand.java b/src/main/java/com/googlesource/gerrit/plugins/download/command/RepoCommand.java
new file mode 100644
index 0000000..077bac5
--- /dev/null
+++ b/src/main/java/com/googlesource/gerrit/plugins/download/command/RepoCommand.java
@@ -0,0 +1,48 @@
+// Copyright (C) 2013 The Android Open Source Project
+//
+// 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.googlesource.gerrit.plugins.download.command;
+
+import com.google.common.base.CaseFormat;
+import com.google.gerrit.extensions.config.DownloadCommand;
+import com.google.gerrit.extensions.config.DownloadScheme;
+import com.google.gerrit.server.config.DownloadConfig;
+import com.google.inject.Inject;
+
+import com.googlesource.gerrit.plugins.download.scheme.RepoScheme;
+
+public class RepoCommand extends DownloadCommand {
+ private final boolean commandAllowed;
+
+ @Inject
+ RepoCommand(DownloadConfig downloadConfig) {
+ this.commandAllowed = downloadConfig.getDownloadCommands().contains(
+ com.google.gerrit.reviewdb.client.AccountGeneralPreferences.DownloadCommand.REPO_DOWNLOAD);
+ }
+
+ @Override
+ public String getName() {
+ return CaseFormat.UPPER_UNDERSCORE.to(CaseFormat.LOWER_HYPHEN,
+ com.google.gerrit.reviewdb.client.AccountGeneralPreferences.DownloadCommand.REPO_DOWNLOAD.name());
+ }
+
+ @Override
+ public String getCommand(DownloadScheme scheme, String project) {
+ if (!commandAllowed || !(scheme instanceof RepoScheme)) {
+ return null;
+ }
+
+ return scheme.getUrl(project) + " ${ref}";
+ }
+}
diff --git a/src/main/java/com/googlesource/gerrit/plugins/download/scheme/AnonymousGitScheme.java b/src/main/java/com/googlesource/gerrit/plugins/download/scheme/AnonymousGitScheme.java
new file mode 100644
index 0000000..ec2533b
--- /dev/null
+++ b/src/main/java/com/googlesource/gerrit/plugins/download/scheme/AnonymousGitScheme.java
@@ -0,0 +1,64 @@
+// Copyright (C) 2013 The Android Open Source Project
+//
+// 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.googlesource.gerrit.plugins.download.scheme;
+
+import com.google.gerrit.extensions.config.DownloadScheme;
+import com.google.gerrit.server.config.DownloadConfig;
+import com.google.gerrit.server.config.GerritServerConfig;
+import com.google.inject.Inject;
+
+import org.eclipse.jgit.lib.Config;
+
+public class AnonymousGitScheme extends DownloadScheme {
+
+ private final String gitDaemonUrl;
+ private final boolean schemeAllowed;
+
+ @Inject
+ public AnonymousGitScheme(@GerritServerConfig Config cfg,
+ DownloadConfig downloadConfig) {
+ this.gitDaemonUrl =
+ ensureSlash(cfg.getString("gerrit", null, "canonicalGitUrl"));
+ this.schemeAllowed = downloadConfig.getDownloadSchemes().contains(
+ com.google.gerrit.reviewdb.client.AccountGeneralPreferences.DownloadScheme.ANON_GIT)
+ || downloadConfig.getDownloadSchemes().contains(
+ com.google.gerrit.reviewdb.client.AccountGeneralPreferences.DownloadScheme.DEFAULT_DOWNLOADS);
+ }
+
+ @Override
+ public String getName() {
+ return "Anonymous GIT";
+ }
+
+ @Override
+ public String getUrl(String project) {
+ StringBuilder r = new StringBuilder();
+ r.append(gitDaemonUrl);
+ r.append(project);
+ return r.toString();
+ }
+
+ @Override
+ public boolean isEnabled() {
+ return schemeAllowed && gitDaemonUrl != null;
+ }
+
+ private static String ensureSlash(String in) {
+ if (in != null && !in.endsWith("/")) {
+ return in + "/";
+ }
+ return in;
+ }
+}
diff --git a/src/main/java/com/googlesource/gerrit/plugins/download/scheme/AnonymousHttpScheme.java b/src/main/java/com/googlesource/gerrit/plugins/download/scheme/AnonymousHttpScheme.java
new file mode 100644
index 0000000..c75ee59
--- /dev/null
+++ b/src/main/java/com/googlesource/gerrit/plugins/download/scheme/AnonymousHttpScheme.java
@@ -0,0 +1,79 @@
+// Copyright (C) 2013 The Android Open Source Project
+//
+// 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.googlesource.gerrit.plugins.download.scheme;
+
+import com.google.gerrit.common.Nullable;
+import com.google.gerrit.extensions.config.DownloadScheme;
+import com.google.gerrit.server.config.CanonicalWebUrl;
+import com.google.gerrit.server.config.DownloadConfig;
+import com.google.gerrit.server.config.GerritServerConfig;
+import com.google.inject.Inject;
+import com.google.inject.Provider;
+
+import org.eclipse.jgit.lib.Config;
+
+public class AnonymousHttpScheme extends DownloadScheme {
+
+ private final String gitHttpUrl;
+ private final String canonicalWebUrl;
+ private final boolean schemeAllowed;
+
+ @Inject
+ public AnonymousHttpScheme(@GerritServerConfig Config cfg,
+ @CanonicalWebUrl @Nullable Provider<String> provider,
+ DownloadConfig downloadConfig) {
+ this.gitHttpUrl = ensureSlash(cfg.getString("gerrit", null, "gitHttpUrl"));
+ this.canonicalWebUrl = provider != null ? provider.get() : null;
+ this.schemeAllowed = downloadConfig.getDownloadSchemes().contains(
+ com.google.gerrit.reviewdb.client.AccountGeneralPreferences.DownloadScheme.ANON_HTTP)
+ || downloadConfig.getDownloadSchemes().contains(
+ com.google.gerrit.reviewdb.client.AccountGeneralPreferences.DownloadScheme.DEFAULT_DOWNLOADS);
+ }
+
+ @Override
+ public String getName() {
+ return "Anonymous HTTP";
+ }
+
+ @Override
+ public String getUrl(String project) {
+ if (!isEnabled()) {
+ return null;
+ }
+
+ final StringBuilder r = new StringBuilder();
+ if (gitHttpUrl != null) {
+ r.append(gitHttpUrl);
+ } else if (canonicalWebUrl != null) {
+ r.append(canonicalWebUrl);
+ } else {
+ throw new IllegalStateException("No HTTP URL");
+ }
+ r.append(project);
+ return r.toString();
+ }
+
+ @Override
+ public boolean isEnabled() {
+ return schemeAllowed && (gitHttpUrl != null || canonicalWebUrl != null);
+ }
+
+ private static String ensureSlash(String in) {
+ if (in != null && !in.endsWith("/")) {
+ return in + "/";
+ }
+ return in;
+ }
+}
diff --git a/src/main/java/com/googlesource/gerrit/plugins/download/scheme/HttpScheme.java b/src/main/java/com/googlesource/gerrit/plugins/download/scheme/HttpScheme.java
new file mode 100644
index 0000000..6389f80
--- /dev/null
+++ b/src/main/java/com/googlesource/gerrit/plugins/download/scheme/HttpScheme.java
@@ -0,0 +1,90 @@
+// Copyright (C) 2013 The Android Open Source Project
+//
+// 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.googlesource.gerrit.plugins.download.scheme;
+
+import com.google.gerrit.common.Nullable;
+import com.google.gerrit.extensions.config.DownloadScheme;
+import com.google.gerrit.server.config.CanonicalWebUrl;
+import com.google.gerrit.server.config.DownloadConfig;
+import com.google.gerrit.server.config.GerritServerConfig;
+import com.google.inject.Inject;
+import com.google.inject.Provider;
+
+import org.eclipse.jgit.lib.Config;
+
+public class HttpScheme extends DownloadScheme {
+
+ private final String gitHttpUrl;
+ private final String canonicalWebUrl;
+ private final boolean schemeAllowed;
+
+ @Inject
+ public HttpScheme(@GerritServerConfig Config cfg,
+ @CanonicalWebUrl @Nullable Provider<String> provider,
+ DownloadConfig downloadConfig) {
+ this.gitHttpUrl = ensureSlash(cfg.getString("gerrit", null, "gitHttpUrl"));
+ this.canonicalWebUrl = provider != null ? provider.get() : null;
+ this.schemeAllowed = downloadConfig.getDownloadSchemes().contains(
+ com.google.gerrit.reviewdb.client.AccountGeneralPreferences.DownloadScheme.HTTP)
+ || downloadConfig.getDownloadSchemes().contains(
+ com.google.gerrit.reviewdb.client.AccountGeneralPreferences.DownloadScheme.DEFAULT_DOWNLOADS);
+ }
+
+ @Override
+ public String getName() {
+ return "HTTP";
+ }
+
+ @Override
+ public String getUrl(String project) {
+ if (!isEnabled()) {
+ return null;
+ }
+
+ final StringBuilder r = new StringBuilder();
+ if (gitHttpUrl != null) {
+ r.append(gitHttpUrl);
+ } else if (canonicalWebUrl != null) {
+ String base = canonicalWebUrl;
+ int p = base.indexOf("://");
+ int s = base.indexOf('/', p + 3);
+ if (s < 0) {
+ s = base.length();
+ }
+ String host = base.substring(p + 3, s);
+ r.append(base.substring(0, p + 3));
+ r.append("${username}@");
+ r.append(host);
+ r.append(base.substring(s));
+ } else {
+ return null;
+ }
+ r.append(project);
+ return r.toString();
+ }
+
+ @Override
+ public boolean isEnabled() {
+ return schemeAllowed && (gitHttpUrl != null || canonicalWebUrl != null);
+ }
+
+ private static String ensureSlash(String in) {
+ if (in != null && !in.endsWith("/")) {
+ return in + "/";
+ }
+ return in;
+ }
+}
diff --git a/src/main/java/com/googlesource/gerrit/plugins/download/scheme/RepoScheme.java b/src/main/java/com/googlesource/gerrit/plugins/download/scheme/RepoScheme.java
new file mode 100644
index 0000000..a3fb11d
--- /dev/null
+++ b/src/main/java/com/googlesource/gerrit/plugins/download/scheme/RepoScheme.java
@@ -0,0 +1,50 @@
+// Copyright (C) 2013 The Android Open Source Project
+//
+// 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.googlesource.gerrit.plugins.download.scheme;
+
+import com.google.gerrit.extensions.annotations.Listen;
+import com.google.gerrit.extensions.config.DownloadScheme;
+import com.google.gerrit.server.config.DownloadConfig;
+import com.google.inject.Inject;
+
+@Listen
+public class RepoScheme extends DownloadScheme {
+
+ private final boolean schemeAllowed;
+
+ @Inject
+ RepoScheme(DownloadConfig downloadConfig) {
+ this.schemeAllowed = downloadConfig.getDownloadSchemes().contains(
+ com.google.gerrit.reviewdb.client.AccountGeneralPreferences.DownloadScheme.REPO_DOWNLOAD);
+ }
+
+ @Override
+ public String getName() {
+ return "REPO";
+ }
+
+ @Override
+ public String getUrl(String project) {
+ final StringBuilder r = new StringBuilder();
+ r.append("repo download ");
+ r.append(project);
+ return r.toString();
+ }
+
+ @Override
+ public boolean isEnabled() {
+ return schemeAllowed;
+ }
+}
diff --git a/src/main/java/com/googlesource/gerrit/plugins/download/scheme/SshScheme.java b/src/main/java/com/googlesource/gerrit/plugins/download/scheme/SshScheme.java
new file mode 100644
index 0000000..1d4d771
--- /dev/null
+++ b/src/main/java/com/googlesource/gerrit/plugins/download/scheme/SshScheme.java
@@ -0,0 +1,85 @@
+// Copyright (C) 2013 The Android Open Source Project
+//
+// 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.googlesource.gerrit.plugins.download.scheme;
+
+import com.google.gerrit.extensions.annotations.Listen;
+import com.google.gerrit.extensions.config.DownloadScheme;
+import com.google.gerrit.server.config.DownloadConfig;
+import com.google.gerrit.server.ssh.SshAdvertisedAddresses;
+import com.google.inject.Inject;
+
+import java.util.List;
+
+@Listen
+public class SshScheme extends DownloadScheme {
+ private final String sshUrl;
+ private final String sshdAddress;
+ private final boolean schemeAllowed;
+
+ @Inject
+ SshScheme(@SshAdvertisedAddresses List<String> sshAddresses,
+ DownloadConfig downloadConfig) {
+ this.sshUrl =
+ !sshAddresses.isEmpty() ? ensureSlash(sshAddresses.get(0)) : null;
+ if (sshUrl != null) {
+ String sshAddr = sshUrl;
+ StringBuilder r = new StringBuilder();
+ r.append("ssh://${username}@");
+ if (sshAddr.startsWith("*:") || "".equals(sshAddr)) {
+ r.append("${hostname}");
+ }
+ if (sshAddr.startsWith("*")) {
+ sshAddr = sshAddr.substring(1);
+ }
+ r.append(sshAddr);
+ sshdAddress = r.toString();
+ } else {
+ sshdAddress = null;
+ }
+ this.schemeAllowed = downloadConfig.getDownloadSchemes().contains(
+ com.google.gerrit.reviewdb.client.AccountGeneralPreferences.DownloadScheme.SSH)
+ || downloadConfig.getDownloadSchemes().contains(
+ com.google.gerrit.reviewdb.client.AccountGeneralPreferences.DownloadScheme.DEFAULT_DOWNLOADS);
+ }
+
+ @Override
+ public String getName() {
+ return "SSH";
+ }
+
+ @Override
+ public String getUrl(String project) {
+ if (!isEnabled()) {
+ return null;
+ }
+
+ StringBuilder r = new StringBuilder();
+ r.append(ensureSlash(sshdAddress));
+ r.append(project);
+ return r.toString();
+ }
+
+ @Override
+ public boolean isEnabled() {
+ return schemeAllowed && sshUrl != null;
+ }
+
+ private static String ensureSlash(String in) {
+ if (in != null && !in.endsWith("/")) {
+ return in + "/";
+ }
+ return in;
+ }
+}
diff --git a/src/main/resources/Documentation/about.md b/src/main/resources/Documentation/about.md
new file mode 100644
index 0000000..0afeb99
--- /dev/null
+++ b/src/main/resources/Documentation/about.md
@@ -0,0 +1,58 @@
+This plugin defines commands for downloading changes / projects in
+different download schemes (for downloading via different network
+protocols).
+
+Download Schemes
+----------------
+
+The following download schemes are defined by this plugin. Please note
+that some download schemes must be enabled by [configuration]
+(config.html#download.scheme).
+
+* `Anonymous Git`: Scheme for anonymous downloads via the Git protocol.
+
+* `Anonymous HTTP`: Scheme for anonymous downloads via the HTTP protocol.
+
+* `HTTP`: Scheme for authenticated downloads via the HTTP protocol.
+
+* `SSH`: Scheme for authenticated downloads via the SSH protocol.
+
+* `REPO`: Scheme for downloading with the Repo tool.
+
+Download Commands
+-----------------
+
+The following download commands are defined by this plugin. Please note
+that some download commands must be enabled by [configuration]
+(config.html#download.command).
+
+### Git Commands
+
+All Git commands are for the Git command line. The Git commands are
+available for the schemes `Anonymous Git`, `Anonymous HTTP`, `HTTP` and
+`SSH`.
+
+* `Checkout`:
+Command to fetch and checkout a patch set.
+
+* `Cherry-Pick`:
+Command to fetch a patch set and cherry-pick it onto the current
+commit.
+
+* `Clone`:
+Command to clone a project.
+
+* `Format-Patch`:
+Command to fetch a patch set and feed it into the `format-patch`
+command.
+
+* `Pull`:
+Command to pull a patch set.
+
+### Repo Commands
+
+The `Repo` command is only available for the `REPO` scheme.
+
+* `Repo`:
+Command to download a patch set of a change with the Repo tool.
+
diff --git a/src/main/resources/Documentation/config.md b/src/main/resources/Documentation/config.md
new file mode 100644
index 0000000..1d66c5f
--- /dev/null
+++ b/src/main/resources/Documentation/config.md
@@ -0,0 +1,67 @@
+@PLUGIN@ Configuration
+======================
+
+By configuration it is possible to specify which download schemes and
+commands are enabled.
+
+The configuration must be done in the `gerrit.config` of the Gerrit
+server.
+
+### <a id="download">Section download</a>
+
+```
+[download]
+ command = checkout
+ command = cherry_pick
+ command = pull
+ command = format_patch
+ scheme = ssh
+ scheme = http
+ scheme = anon_http
+ scheme = anon_git
+ scheme = repo_download
+```
+
+The download section configures the allowed download methods.
+
+<a id="download.command">download.command</a>
+: 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 cherry-pick
+ it onto the current commit.
+
+ * `pull`: Command to pull the patch set.
+
+ * `format_patch`: Command to fetch the patch set and feed it
+ into the `format-patch` command.
+
+ If `download.command` is not specified, all download commands are
+ offered.
+
+<a id="download.scheme">download.scheme</a>
+: Schemes that should be used to download changes.
+
+ Multiple schemes are supported:
+
+ * `http`: Authenticated HTTP download is allowed.
+
+ * `ssh`: Authenticated SSH download is allowed.
+
+ * `anon_http`: Anonymous HTTP download is allowed.
+
+ * `anon_git`: Anonymous Git download is allowed. This is not
+ default, it is also necessary to set [gerrit.canonicalGitUrl]
+ (../../../Documentation/config-gerrit.html#gerrit.canonicalGitUrl)
+ variable.
+
+ * `repo_download`: Gerrit advertises patch set downloads with the
+ `repo download` command, assuming that all projects managed by this
+ instance are 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
+ downloads are allowed.
