Initial revision of motd plugin
Add a basic motd displayed on fetch as well as per-subnet messages.
Depends-On: I5d0aeac51b83bf14150fa3036f71965cf2051243
Change-Id: Iecdf21a56ba957aadf9c565557e5cb9f90b32fc1
diff --git a/BUCK b/BUCK
new file mode 100644
index 0000000..67dc671
--- /dev/null
+++ b/BUCK
@@ -0,0 +1,17 @@
+gerrit_plugin(
+ name = 'motd',
+ srcs = glob(['src/main/java/**/*.java']),
+ resources = glob(['src/main/resources/**/*']),
+ manifest_entries = [
+ 'Gerrit-PluginName: motd',
+ 'Gerrit-Module: com.googlesource.gerrit.plugins.motd.Module',
+ 'Implementation-Title: Message of the Day',
+ 'Implementation-URL: https://gerrit.googlesource.com/plugins/motd',
+ ],
+ # Deps shared with Gerrit but not in the plugin API.
+ provided_deps = [
+ '//lib/jgit:jgit',
+ '//lib/commons:net',
+ ],
+)
+
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/motd/DisplayMotd.java b/src/main/java/com/googlesource/gerrit/plugins/motd/DisplayMotd.java
new file mode 100644
index 0000000..06fcf14
--- /dev/null
+++ b/src/main/java/com/googlesource/gerrit/plugins/motd/DisplayMotd.java
@@ -0,0 +1,74 @@
+// Copyright (C) 2014 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.motd;
+
+import com.google.gerrit.reviewdb.client.Project;
+import com.google.gerrit.server.CurrentUser;
+import com.google.gerrit.server.git.validators.UploadValidationListener;
+import com.google.gerrit.server.validators.ValidationException;
+import com.google.inject.Inject;
+
+import org.eclipse.jgit.lib.ObjectId;
+import org.eclipse.jgit.lib.Repository;
+import org.eclipse.jgit.transport.UploadPack;
+
+import java.io.PrintWriter;
+import java.net.InetAddress;
+import java.net.UnknownHostException;
+import java.util.Collection;
+
+class DisplayMotd implements UploadValidationListener {
+ private final CurrentUser user;
+ private final MotdConfig config;
+
+ @Inject
+ public DisplayMotd(CurrentUser user, MotdConfig config) {
+ this.user = user;
+ this.config = config;
+ }
+
+ @Override
+ public void onPreUpload(Repository repository, Project project,
+ String remote, UploadPack up, Collection<? extends ObjectId> wants,
+ Collection<? extends ObjectId> haves) throws ValidationException {
+ PrintWriter pw = new PrintWriter(up.getMessageOutputStream());
+
+ if (config.getMotd() != null) {
+ pw.print(format(config.getMotd()));
+ pw.print("\n");
+ }
+
+ try {
+ String inet = InetAddress.getByName(remote).getHostAddress();
+ for (Subnet m : config.getSubnets()) {
+ if (m.isInRange(inet) && m.getMotd() != null) {
+ pw.print(format(m.getMotd()));
+ pw.print("\n");
+ break;
+ }
+ }
+ } catch (UnknownHostException e) {
+ // Couldn't look up the hostname; this is non-fatal
+ }
+ pw.flush();
+ }
+
+ private String format(String message) {
+ if (user.getUserName() != null) {
+ message = message.replace("${user}", user.getUserName());
+ }
+ return message;
+ }
+}
diff --git a/src/main/java/com/googlesource/gerrit/plugins/motd/Module.java b/src/main/java/com/googlesource/gerrit/plugins/motd/Module.java
new file mode 100644
index 0000000..d5b019d
--- /dev/null
+++ b/src/main/java/com/googlesource/gerrit/plugins/motd/Module.java
@@ -0,0 +1,35 @@
+// Copyright (C) 2014 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.motd;
+
+import com.google.gerrit.extensions.events.LifecycleListener;
+import com.google.gerrit.extensions.registration.DynamicSet;
+import com.google.inject.AbstractModule;
+import com.google.inject.Scopes;
+import com.google.inject.internal.UniqueAnnotations;
+
+import com.google.gerrit.server.git.validators.UploadValidationListener;
+
+class Module extends AbstractModule {
+ @Override
+ protected void configure() {
+ DynamicSet.bind(binder(), UploadValidationListener.class).to(
+ DisplayMotd.class);
+ bind(OnStartStop.class).in(Scopes.SINGLETON);
+ bind(LifecycleListener.class).annotatedWith(UniqueAnnotations.create()).to(
+ OnStartStop.class);
+ bind(MotdConfig.class).to(MotdFileBasedConfig.class);
+ }
+}
diff --git a/src/main/java/com/googlesource/gerrit/plugins/motd/MotdConfig.java b/src/main/java/com/googlesource/gerrit/plugins/motd/MotdConfig.java
new file mode 100644
index 0000000..82b3615
--- /dev/null
+++ b/src/main/java/com/googlesource/gerrit/plugins/motd/MotdConfig.java
@@ -0,0 +1,26 @@
+// Copyright (C) 2014 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.motd;
+
+import java.util.List;
+
+public interface MotdConfig {
+
+ List<Subnet> getSubnets();
+
+ String getMotd();
+
+ boolean isEmpty();
+
+}
diff --git a/src/main/java/com/googlesource/gerrit/plugins/motd/MotdFileBasedConfig.java b/src/main/java/com/googlesource/gerrit/plugins/motd/MotdFileBasedConfig.java
new file mode 100644
index 0000000..07e5772
--- /dev/null
+++ b/src/main/java/com/googlesource/gerrit/plugins/motd/MotdFileBasedConfig.java
@@ -0,0 +1,144 @@
+// Copyright (C) 2014 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.motd;
+
+import com.google.common.collect.ImmutableList;
+import com.google.common.collect.Lists;
+import com.google.gerrit.server.config.SitePaths;
+import com.google.inject.Inject;
+import com.google.inject.Singleton;
+
+import org.apache.commons.net.util.SubnetUtils;
+import org.eclipse.jgit.errors.ConfigInvalidException;
+import org.eclipse.jgit.storage.file.FileBasedConfig;
+import org.eclipse.jgit.util.FS;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import java.io.File;
+import java.io.IOException;
+import java.util.Collections;
+import java.util.List;
+import java.util.Set;
+
+@Singleton
+public class MotdFileBasedConfig implements MotdConfig {
+ static final Logger log = LoggerFactory.getLogger(MotdFileBasedConfig.class);
+ private List<Subnet> subnets;
+ private File cfgPath;
+ private String motd;
+ private final FileBasedConfig config;
+
+ @Inject
+ public MotdFileBasedConfig(final SitePaths site)
+ throws ConfigInvalidException, IOException {
+ this.cfgPath = new File(site.etc_dir, "motd.config");
+ log.info("Loading configuration from " + cfgPath);
+ this.config = new FileBasedConfig(cfgPath, FS.DETECTED);
+ this.subnets = allSubnets();
+ }
+
+ /*
+ * (non-Javadoc)
+ *
+ * @see com.googlesource.gerrit.plugins.motd.MotdConfig#getSubnets()
+ */
+ @Override
+ public List<Subnet> getSubnets() {
+ return subnets;
+ }
+
+ private List<Subnet> allSubnets() throws ConfigInvalidException, IOException {
+ if (!config.getFile().exists()) {
+ log.warn("Config file " + config.getFile()
+ + " does not exist; not providing messages");
+ return Collections.emptyList();
+ }
+ if (config.getFile().length() == 0) {
+ log.info("Config file " + config.getFile()
+ + " is empty; not providing messages");
+ return Collections.emptyList();
+ }
+
+ try {
+ config.load();
+ } catch (ConfigInvalidException e) {
+ throw new ConfigInvalidException(String.format(
+ "Config file %s is invalid: %s", config.getFile(), e.getMessage()), e);
+ } catch (IOException e) {
+ throw new IOException(String.format("Cannot read %s: %s",
+ config.getFile(), e.getMessage()), e);
+ }
+
+ motd = config.getString("gerrit", null, "motd");
+
+ ImmutableList.Builder<Subnet> subnetlist = ImmutableList.builder();
+ for (SubnetConfig c : allSubnets(config)) {
+ if (c.getMotd().isEmpty()) {
+ log.warn("Subnet configuration for " + c.getSubnet()
+ + " has no message");
+ continue;
+ }
+
+ try {
+ SubnetUtils su = new SubnetUtils(c.getSubnet());
+ Subnet subnet = new Subnet(c, su);
+ subnetlist.add(subnet);
+ } catch (IllegalArgumentException e) {
+ log.warn("Subnet '" + c.getSubnet() + "' is invalid; skipping");
+ continue;
+ }
+ }
+
+ return subnetlist.build();
+ }
+
+ /*
+ * (non-Javadoc)
+ *
+ * @see com.googlesource.gerrit.plugins.motd.MotdConfig#getMotd()
+ */
+ @Override
+ public String getMotd() {
+ return motd;
+ }
+
+ private static List<SubnetConfig> allSubnets(FileBasedConfig cfg)
+ throws ConfigInvalidException {
+ Set<String> names = cfg.getSubsections("subnet");
+ List<SubnetConfig> result = Lists.newArrayListWithCapacity(names.size());
+ for (String name : names) {
+ result.add(new SubnetConfig(cfg, name));
+ }
+ return result;
+ }
+
+ /*
+ * (non-Javadoc)
+ *
+ * @see com.googlesource.gerrit.plugins.motd.MotdConfig#isEmpty()
+ */
+ @Override
+ public boolean isEmpty() {
+ return subnets.isEmpty();
+ }
+
+ File getCfgPath() {
+ return cfgPath;
+ }
+
+ FileBasedConfig getConfig() {
+ return config;
+ }
+}
diff --git a/src/main/java/com/googlesource/gerrit/plugins/motd/OnStartStop.java b/src/main/java/com/googlesource/gerrit/plugins/motd/OnStartStop.java
new file mode 100644
index 0000000..8581180
--- /dev/null
+++ b/src/main/java/com/googlesource/gerrit/plugins/motd/OnStartStop.java
@@ -0,0 +1,38 @@
+// Copyright (C) 2014 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.motd;
+
+import com.google.gerrit.extensions.events.LifecycleListener;
+import com.google.inject.Inject;
+
+class OnStartStop implements LifecycleListener {
+ private final MotdConfig config;
+
+ @Inject
+ OnStartStop(MotdConfig config) {
+ // Set up a config so we load the config at startup.
+ this.config = config;
+ }
+
+ @Override
+ public void start() {
+ /* do nothing */
+ }
+
+ @Override
+ public void stop() {
+ /* do nothing */
+ }
+}
diff --git a/src/main/java/com/googlesource/gerrit/plugins/motd/Subnet.java b/src/main/java/com/googlesource/gerrit/plugins/motd/Subnet.java
new file mode 100644
index 0000000..98fc099
--- /dev/null
+++ b/src/main/java/com/googlesource/gerrit/plugins/motd/Subnet.java
@@ -0,0 +1,34 @@
+// Copyright (C) 2014 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.motd;
+
+import org.apache.commons.net.util.SubnetUtils;
+
+class Subnet {
+ private String motd;
+ private SubnetUtils subnet;
+
+ public Subnet(SubnetConfig c, SubnetUtils subnet) {
+ this.motd = c.getMotd();
+ this.subnet = subnet;
+ }
+
+ public String getMotd() {
+ return motd;
+ }
+
+ public boolean isInRange(String addr) {
+ return subnet.getInfo().isInRange(addr);
+ }
+}
diff --git a/src/main/java/com/googlesource/gerrit/plugins/motd/SubnetConfig.java b/src/main/java/com/googlesource/gerrit/plugins/motd/SubnetConfig.java
new file mode 100644
index 0000000..20d4112
--- /dev/null
+++ b/src/main/java/com/googlesource/gerrit/plugins/motd/SubnetConfig.java
@@ -0,0 +1,37 @@
+// Copyright (C) 2014 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.motd;
+
+import org.eclipse.jgit.storage.file.FileBasedConfig;
+
+class SubnetConfig {
+ private String motd;
+ private String subnet;
+
+ public SubnetConfig(final FileBasedConfig c, final String name) {
+ this.motd = c.getString("subnet", name, "motd");
+ if (this.motd == null) {
+ this.motd = "";
+ }
+ this.subnet = name;
+ }
+
+ public String getMotd() {
+ return motd;
+ }
+
+ public String getSubnet() {
+ return subnet;
+ }
+}
diff --git a/src/main/resources/Documentation/about.md b/src/main/resources/Documentation/about.md
new file mode 100644
index 0000000..0fa0941
--- /dev/null
+++ b/src/main/resources/Documentation/about.md
@@ -0,0 +1,9 @@
+This plugin can output messages to clients when pulling/fetching/cloning
+code from Gerrit Code Review. If the client (and transport mechanism)
+can support sending the message to the client, it will be displayed to
+the user (usually prefixed by "remote: "), but will be silently discarded
+otherwise.
+
+Messages may be configured for either the entire server, or based on the
+subnet of the client connecting.
+
diff --git a/src/main/resources/Documentation/config.md b/src/main/resources/Documentation/config.md
new file mode 100644
index 0000000..222274b
--- /dev/null
+++ b/src/main/resources/Documentation/config.md
@@ -0,0 +1,31 @@
+MOTD Configuration
+==================
+
+Reloading Messages
+------------------
+
+To reload the current messages displayed to clients, simply reload the plugin:
+
+```
+ ssh -p 29418 localhost gerrit plugin reload motd
+```
+
+File `motd.config`
+------------------
+
+The file `$site_path/etc/motd.config` is a Git-style config file that contains
+the messages and subnet-based messages to be displayed to users. It contains
+an optional global message, and optional sections for subnet-specific messages.
+
+Subnet-based configurations should replace the `SUBNET` portion with the
+appropriate subnet in CIDR-style notation.
+
+Optionally, the parameter `${user}` will be substituted into any message as
+the user's username. If user is unauthenticated, the substitution will not
+be performed.
+
+gerrit.motd
+: Message to be displayed to all users, regardless of their IP.
+
+subnet.SUBNET.motd
+: Message to be displayed to users with an IP in range of `SUBNET`.
\ No newline at end of file
