org.zanata.maven.AbstractPushPullMojo Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of zanata-maven-plugin Show documentation
Zanata client for managing projects, publishing source text and retrieving translations.
There is a newer version: 4.6.2
package org.zanata.maven;

import java.util.List;

import com.google.common.collect.ImmutableSet;
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.project.MavenProject;
import org.zanata.client.commands.PushPullCommand;
import org.zanata.client.commands.PushPullOptions;
import org.zanata.client.config.LocaleList;

/**
 * @author Sean Flanigan [email protected]
 */
abstract class AbstractPushPullMojo extends
        ConfigurableProjectMojo implements PushPullOptions {
    protected static final String PROJECT_TYPE_FILE = "file";

    /**
     * Separator used between components of the module ID
     */
    private static final char MODULE_SEPARATOR = '/';

    /**
     * Separator used between components of the module ID for use by maven
     */
    private static final char MVN_MODULE_SEPARATOR = ':';

    private static final char MODULE_SUFFIX = '/';

    @Override
    protected void runCommand() throws Exception {
        if (skip) {
            getLog().info("skipping");
            return;
        }
        super.runCommand();
    }

    @Override
    public boolean isRootModule() {
        return project.isExecutionRoot();
    }

    @Override
    public String getCurrentModule() {
        return getCurrentModule(false);
    }

    @Override
    public String getCurrentModule(boolean canonicalName) {
        if (project == null || !getEnableModules()) {
            return "";
        }
        if (canonicalName) {
            return toMavenModuleID(project);
        }
        return toModuleID(project);
    }

    @Override
    public String getModuleSuffix() {
        return "" + MODULE_SUFFIX;
    }

    @Override
    public String getDocNameRegex() {
        return "^([^/]+/[^" + MODULE_SUFFIX + "]+)" + MODULE_SUFFIX + "(.+)";
    }

    @Override
    public ImmutableSet getAllModules() {
        ImmutableSet.Builder builder = ImmutableSet.builder();
        for (MavenProject module : reactorProjects) {
            String modID = toModuleID(module);
            builder.add(modID);
        }
        return builder.build();
    }

    private String toModuleID(MavenProject module) {
        return module.getGroupId() + MODULE_SEPARATOR + module.getArtifactId();
    }

    private String toMavenModuleID(MavenProject module) {
        return module.getGroupId() + MVN_MODULE_SEPARATOR
                + module.getArtifactId();
    }

    @Parameter(defaultValue = "${project}", readonly = true)
    private MavenProject project;

    /**
     * Dry run: don't change any data, on the server or on the filesystem.
     */
    @Parameter(property = "dryRun")
    private boolean dryRun = false;

    @Parameter(property = "zanata.skip")
    private boolean skip;

    /**
     * The projects in the reactor.
     */
    @Parameter(defaultValue = "${reactorProjects}", readonly = true)
    private List reactorProjects;

    /**
     * Specifies a document from which to begin the push operation. Documents
     * before this document (sorted alphabetically) will not be pushed.
     *
     * For multi-module projects, the full document path including module id is
     * required.
     *
     * Use this option to resume a failed push operation.
     */
    @Parameter(property = "zanata.fromDoc")
    private String fromDoc;

    /**
     * Locales to push to/pull from the server. By default all locales
     * configured for the project will be pushed/pulled.
     * Usage:
     * -Dzanata.locales=locale1,locale2,locale3
     */
    @Parameter(property = "zanata.locales")
    private String[] locales;

    private LocaleList effectiveLocales;

    public AbstractPushPullMojo() {
        super();
    }

    /**
     * @return the dryRun
     */
    @Override
    public boolean isDryRun() {
        return dryRun;
    }

    @Override
    public String getSrcDirParameterName() {
        return "srcDir";
    }

    @Override
    public String getFromDoc() {
        return fromDoc;
    }

    @Override
    public String buildFromDocArgument(String argValue) {
        return "-Dzanata.fromDoc=\"" + argValue + "\"";
    }

    /**
     * Override the default
     * {@link org.zanata.maven.ConfigurableProjectMojo#getLocaleMapList()}
     * method as the push command can have locales specified via command line.
     *
     * @return The locale map list taking into account the global locales in
     *         zanata.xml as well as the command line argument ones.
     */
    @Override
    public LocaleList getLocaleMapList() {
        if (effectiveLocales == null) {
            effectiveLocales =
                    PushPullCommand.getLocaleMapList(super.getLocaleMapList(),
                            locales);
        }

        return effectiveLocales;
    }

}