From 938508c902df389d2d7e621be5443fa1100ba4cc Mon Sep 17 00:00:00 2001 From: Sebastian Sdorra Date: Fri, 20 May 2011 13:41:44 +0200 Subject: [PATCH] added TemplateSubCommand --- scm-clients/scm-cli-client/pom.xml | 6 + .../cli/cmd/ListRepositoriesSubCommand.java | 17 +- .../sonia/scm/cli/cmd/TemplateSubCommand.java | 177 ++++++++++++++++++ .../resources/sonia/resources/i18n.properties | 2 + .../sonia/resources/list-repositories.ftl | 18 ++ 5 files changed, 215 insertions(+), 5 deletions(-) create mode 100644 scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/TemplateSubCommand.java create mode 100644 scm-clients/scm-cli-client/src/main/resources/sonia/resources/list-repositories.ftl diff --git a/scm-clients/scm-cli-client/pom.xml b/scm-clients/scm-cli-client/pom.xml index 1fabd206e4..19046bd8c8 100644 --- a/scm-clients/scm-cli-client/pom.xml +++ b/scm-clients/scm-cli-client/pom.xml @@ -54,6 +54,12 @@ logback-classic 0.9.28 + + + org.freemarker + freemarker + 2.3.16 + diff --git a/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/ListRepositoriesSubCommand.java b/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/ListRepositoriesSubCommand.java index 74818c26b0..51e91cf592 100644 --- a/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/ListRepositoriesSubCommand.java +++ b/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/ListRepositoriesSubCommand.java @@ -40,16 +40,24 @@ import sonia.scm.repository.Repository; //~--- JDK imports ------------------------------------------------------------ +import java.util.HashMap; import java.util.List; +import java.util.Map; /** * * @author Sebastian Sdorra */ @Command("list-repositories") -public class ListRepositoriesSubCommand extends SubCommand +public class ListRepositoriesSubCommand extends TemplateSubCommand { + /** Field description */ + public static final String TEMPLATE = + "/sonia/resources/list-repositories.ftl"; + + //~--- methods -------------------------------------------------------------- + /** * Method description * @@ -59,10 +67,9 @@ public class ListRepositoriesSubCommand extends SubCommand { ScmClientSession session = createSession(); List repositories = session.getRepositoryHandler().getAll(); + Map env = new HashMap(); - for (Repository r : repositories) - { - output.println(r); - } + env.put("repositories", repositories); + renderTemplate(env, TEMPLATE); } } diff --git a/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/TemplateSubCommand.java b/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/TemplateSubCommand.java new file mode 100644 index 0000000000..6960b9756d --- /dev/null +++ b/scm-clients/scm-cli-client/src/main/java/sonia/scm/cli/cmd/TemplateSubCommand.java @@ -0,0 +1,177 @@ +/** + * Copyright (c) 2010, Sebastian Sdorra + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are met: + * + * 1. Redistributions of source code must retain the above copyright notice, + * this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright notice, + * this list of conditions and the following disclaimer in the documentation + * and/or other materials provided with the distribution. + * 3. Neither the name of SCM-Manager; nor the names of its + * contributors may be used to endorse or promote products derived from this + * software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" + * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE + * DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY + * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES + * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON + * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS + * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + * + * http://bitbucket.org/sdorra/scm-manager + * + */ + + + +package sonia.scm.cli.cmd; + +//~--- non-JDK imports -------------------------------------------------------- + +import freemarker.template.Configuration; +import freemarker.template.Template; +import freemarker.template.TemplateException; + +import org.kohsuke.args4j.Option; + +import sonia.scm.ConfigurationException; +import sonia.scm.util.IOUtil; +import sonia.scm.util.Util; + +//~--- JDK imports ------------------------------------------------------------ + +import java.io.File; +import java.io.FileReader; +import java.io.IOException; +import java.io.InputStreamReader; +import java.io.Reader; +import java.io.StringReader; + +import java.util.Map; + +/** + * + * @author Sebastian Sdorra + */ +public abstract class TemplateSubCommand extends SubCommand +{ + + /** + * Method description + * + * + * @return + */ + public String getTemplate() + { + return template; + } + + /** + * Method description + * + * + * @return + */ + public File getTemplateFile() + { + return templateFile; + } + + //~--- set methods ---------------------------------------------------------- + + /** + * Method description + * + * + * @param template + */ + public void setTemplate(String template) + { + this.template = template; + } + + /** + * Method description + * + * + * @param templateFile + */ + public void setTemplateFile(File templateFile) + { + this.templateFile = templateFile; + } + + //~--- methods -------------------------------------------------------------- + + /** + * Method description + * + * + * @param env + * @param defaultTemplate + */ + protected void renderTemplate(Map env, String defaultTemplate) + { + Configuration configuration = new Configuration(); + Reader reader = null; + + try + { + if ((templateFile != null) && templateFile.exists()) + { + reader = new FileReader(templateFile); + } + else if (Util.isNotEmpty(template)) + { + reader = new StringReader(template); + } + else + { + reader = new InputStreamReader( + TemplateSubCommand.class.getResourceAsStream(defaultTemplate)); + } + + Template tpl = new Template("default-template", reader, configuration); + + tpl.process(env, output); + } + catch (TemplateException ex) + { + throw new ConfigurationException("could not render template", ex); + } + catch (IOException ex) + { + throw new ConfigurationException("could not render template", ex); + } + finally + { + IOUtil.close(reader); + } + } + + //~--- fields --------------------------------------------------------------- + + /** Field description */ + @Option( + name = "--template", + usage = "optionTemplate", + aliases = { "-t" } + ) + private String template; + + /** Field description */ + @Option( + name = "--template-file", + usage = "optionTemplateFile", + aliases = { "-f" } + ) + private File templateFile; +} diff --git a/scm-clients/scm-cli-client/src/main/resources/sonia/resources/i18n.properties b/scm-clients/scm-cli-client/src/main/resources/sonia/resources/i18n.properties index 333ed143a7..a4f3b92449 100644 --- a/scm-clients/scm-cli-client/src/main/resources/sonia/resources/i18n.properties +++ b/scm-clients/scm-cli-client/src/main/resources/sonia/resources/i18n.properties @@ -34,6 +34,8 @@ optionServerUrl = SCM-Manager URL optionUsername = Username optionPassword = Password optionHelpText = Shows this help +optionTemplate = Template +optionTemplateFile = Template file metaVar_config = configname metaVar_arg = subcommand arguments diff --git a/scm-clients/scm-cli-client/src/main/resources/sonia/resources/list-repositories.ftl b/scm-clients/scm-cli-client/src/main/resources/sonia/resources/list-repositories.ftl new file mode 100644 index 0000000000..67c60df258 --- /dev/null +++ b/scm-clients/scm-cli-client/src/main/resources/sonia/resources/list-repositories.ftl @@ -0,0 +1,18 @@ +<#list repositories as repository> +ID: ${repository.id} +Name: ${repository.name} +Type: ${repository.type} +E-Mail: ${repository.contact} +Description: ${repository.description} +Public: ${repository.publicReadable?string} +Creation-Date: ${repository.creationDate!""?string} +Last-Modified: ${repository.lastModified!""?string} +URL: ${repository.url} +Permissions: +<#if repository.permissions??> +<#list repository.permissions as permission> + ${permission.type} - ${permission.name} (Group: ${permission.groupPermission?string}) + + + +