MessageGenerator.java

/*
 * Copyright 2015, Red Hat, Inc. and individual contributors as indicated by the
 * @author tags. See the copyright.txt file in the distribution for a full
 * listing of individual contributors.
 *
 * This is free software; you can redistribute it and/or modify it under the
 * terms of the GNU Lesser General Public License as published by the Free
 * Software Foundation; either version 2.1 of the License, or (at your option)
 * any later version.
 *
 * This software is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
 * details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this software; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA, or see the FSF
 * site: http://www.fsf.org.
 */

package org.zanata.util;

import org.apache.commons.lang.StringUtils;
import org.zanata.model.HDocument;
import org.zanata.model.HPerson;
import org.zanata.model.HTextFlowTarget;
import org.zanata.model.tm.TransMemoryUnit;
import org.zanata.webtrans.shared.model.TransMemoryDetails;

/**
 * Generate messages/comments of Zanata business actions
 *
 * @author Alex Eng <a href="mailto:aeng@redhat.com">aeng@redhat.com</a>
 */
public class MessageGenerator {

    /**
     * Prefix of action type for generated message
     */
    public static final String PREFIX_MERGE_TRANS = "Merge translations";
    public static final String PREFIX_COPY_TRANS = "Copy translation";
    public static final String PREFIX_COPY_VERSION = "Copy version";
    public static final String PREFIX_TM_MERGE = "TM Merge";

    /**
     * Create revision comment for translation that is copied by merge
     * translation
     *
     * @see org.zanata.service.MergeTranslationsService
     *
     * @param tft - HTextFlowTarget to copy from
     */
    public static final String getMergeTranslationMessage(
            HTextFlowTarget tft) {
        HDocument document = tft.getTextFlow().getDocument();
        return generateAutoCopiedMessage(PREFIX_MERGE_TRANS,
                document.getProjectIteration().getProject().getName(),
                document.getProjectIteration()
                        .getSlug(), document.getDocId(),
                        getAuthor(tft.getLastModifiedBy()));
    }

    /**
     * Create revision comment for translation that is copied by copy trans
     * @see org.zanata.service.CopyTransService
     *
     * @param tft - HTextFlowTarget to copy from
     */
    public static final String getCopyTransMessage(HTextFlowTarget tft) {
        HDocument document = tft.getTextFlow().getDocument();
        return generateAutoCopiedMessage(PREFIX_COPY_TRANS,
                document.getProjectIteration()
                        .getProject().getName(), document.getProjectIteration()
                        .getSlug(), document.getDocId(),
                        getAuthor(tft.getLastModifiedBy()));
    }

    /**
     * Create revision comment for translation that is copied by copy version
     * @see org.zanata.service.CopyVersionService
     *
     * @param tft - HTextFlowTarget to copy from
     */
    public static final String getCopyVersionMessage(HTextFlowTarget tft) {
        HDocument document = tft.getTextFlow().getDocument();
        return generateAutoCopiedMessage(PREFIX_COPY_VERSION,
                document.getProjectIteration().getProject().getName(),
                document.getProjectIteration()
                        .getSlug(), document.getDocId(),
                        getAuthor(tft.getLastModifiedBy()));
    }

    /**
     * Create revision comment for translation that is copied by TM Merge
     * @see org.zanata.service.TransMemoryMergeService
     *
     * @param tu
     */
    public static final String getTMMergeMessage(TransMemoryUnit tu) {
        StringBuilder comment = new StringBuilder();

        comment.append(PREFIX_TM_MERGE)
            .append(": translation auto-copied from Translation memory '")
            .append(tu.getTranslationMemory().getSlug())
            .append("', description '")
            .append(tu.getTranslationMemory().getDescription())
            .append("'");

       return comment.toString();
    }

    /**
     * Create revision comment for translation that is copied by TM Merge
     * @see org.zanata.service.TransMemoryMergeService
     *
     * @param tu
     */
    public static final String getTMMergeMessage(TransMemoryDetails tmDetails) {
        return generateAutoCopiedMessage(PREFIX_TM_MERGE,
            tmDetails.getProjectName(),
            tmDetails.getIterationName(), tmDetails.getDocId(),
            tmDetails.getLastModifiedBy());
    }

    private static String getAuthor(HPerson person) {
        if (person != null) {
            return person.getName();
        }
        return null;
    }

    private static final String generateAutoCopiedMessage(String prefix,
        String projectName, String versionSlug, String docId, String author) {
        StringBuilder comment = new StringBuilder();

        comment.append(prefix)
            .append(": translation auto-copied from project '")
            .append(projectName)
            .append("', version '")
            .append(versionSlug)
            .append("', document '")
            .append(docId)
            .append("'");

        if (!StringUtils.isEmpty(author)) {
            comment.append(", author '").append(author).append("'");
        }
        return comment.toString();
    }
}