001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *   http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing,
013 * software distributed under the License is distributed on an
014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 * KIND, either express or implied.  See the License for the
016 * specific language governing permissions and limitations
017 * under the License.
018 */
019package org.apache.maven.scm.provider.svn.svnexe.command.untag;
020
021import java.io.File;
022import java.io.IOException;
023
024import org.apache.maven.scm.ScmException;
025import org.apache.maven.scm.ScmFileSet;
026import org.apache.maven.scm.ScmResult;
027import org.apache.maven.scm.ScmTag;
028import org.apache.maven.scm.ScmUntagParameters;
029import org.apache.maven.scm.command.untag.AbstractUntagCommand;
030import org.apache.maven.scm.command.untag.UntagScmResult;
031import org.apache.maven.scm.provider.ScmProviderRepository;
032import org.apache.maven.scm.provider.svn.SvnCommandUtils;
033import org.apache.maven.scm.provider.svn.SvnTagBranchUtils;
034import org.apache.maven.scm.provider.svn.command.SvnCommand;
035import org.apache.maven.scm.provider.svn.repository.SvnScmProviderRepository;
036import org.apache.maven.scm.provider.svn.svnexe.command.SvnCommandLineUtils;
037import org.codehaus.plexus.util.FileUtils;
038import org.codehaus.plexus.util.Os;
039import org.codehaus.plexus.util.cli.CommandLineException;
040import org.codehaus.plexus.util.cli.CommandLineUtils;
041import org.codehaus.plexus.util.cli.Commandline;
042
043/**
044 * scm:untag for provider svn is done by removing the tag dir
045 *
046 * @since 1.11.2
047 */
048public class SvnUntagCommand extends AbstractUntagCommand implements SvnCommand {
049
050    /** {@inheritDoc} */
051    @Override
052    public ScmResult executeUntagCommand(
053            ScmProviderRepository repo, ScmFileSet fileSet, ScmUntagParameters scmUntagParameters) throws ScmException {
054        String tag = scmUntagParameters.getTag();
055        if (tag == null || tag.trim().isEmpty()) {
056            throw new ScmException("tag must be specified");
057        }
058
059        SvnScmProviderRepository repository = (SvnScmProviderRepository) repo;
060
061        File messageFile = FileUtils.createTempFile("maven-scm-", ".commit", null);
062
063        String message = scmUntagParameters.getMessage();
064        try {
065            FileUtils.fileWrite(messageFile.getAbsolutePath(), "UTF-8", message);
066        } catch (IOException ex) {
067            return new UntagScmResult(
068                    null,
069                    "Error while making a temporary file for the commit message: " + ex.getMessage(),
070                    null,
071                    false);
072        }
073
074        Commandline cl = createCommandline(repository, fileSet, tag, messageFile);
075
076        CommandLineUtils.StringStreamConsumer stdout = new CommandLineUtils.StringStreamConsumer();
077
078        CommandLineUtils.StringStreamConsumer stderr = new CommandLineUtils.StringStreamConsumer();
079
080        if (logger.isInfoEnabled()) {
081            logger.info("Executing: " + SvnCommandLineUtils.cryptPassword(cl));
082
083            if (Os.isFamily(Os.FAMILY_WINDOWS)) {
084                logger.info("Working directory: " + cl.getWorkingDirectory().getAbsolutePath());
085            }
086        }
087
088        int exitCode;
089
090        try {
091            exitCode = SvnCommandLineUtils.execute(cl, stdout, stderr);
092        } catch (CommandLineException ex) {
093            throw new ScmException("Error while executing svn remove command.", ex);
094        } finally {
095            try {
096                FileUtils.forceDelete(messageFile);
097            } catch (IOException ex) {
098                // ignore
099            }
100        }
101
102        if (exitCode == 0) {
103            return new UntagScmResult(
104                    cl.toString(), "The svn remove command was successful.", stderr.getOutput(), true);
105        } else {
106            return new UntagScmResult(cl.toString(), "The svn remove command failed.", stderr.getOutput(), false);
107        }
108    }
109
110    /**
111     * create command line from parameters
112     *
113     * @param repo        svn repo tu delete tag from
114     * @param fileSet     file set containing base dir
115     * @param tag         tag to delete
116     * @param messageFile file containing commit message
117     * @return            command line instance
118     */
119    Commandline createCommandline(SvnScmProviderRepository repo, ScmFileSet fileSet, String tag, File messageFile) {
120        Commandline cl = SvnCommandLineUtils.getBaseSvnCommandLine(fileSet.getBasedir(), repo);
121
122        cl.createArg().setValue("--file");
123
124        cl.createArg().setValue(messageFile.getAbsolutePath());
125
126        cl.createArg().setValue("remove");
127
128        String tagUrl = SvnTagBranchUtils.resolveTagUrl(repo, new ScmTag(tag));
129        tagUrl = SvnCommandUtils.fixUrl(tagUrl, repo.getUser());
130        cl.createArg().setValue(tagUrl + "@");
131
132        return cl;
133    }
134}