org.zanata.client.commands.push.AbstractGettextPushStrategy.java Source code

Introduction

Here is the source code for org.zanata.client.commands.push.AbstractGettextPushStrategy.java

Source

/*
 * Copyright 2011, 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.client.commands.push;

import static org.apache.commons.io.FilenameUtils.removeExtension;

import java.io.BufferedInputStream;
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.util.Collection;
import java.util.HashSet;
import java.util.Set;

import com.google.common.collect.ImmutableList;
import org.xml.sax.InputSource;
import org.zanata.adapter.po.PoReader2;
import org.zanata.client.commands.TransFileResolver;
import org.zanata.client.commands.DocNameWithoutExt;
import org.zanata.client.commands.push.PushCommand.TranslationResourcesVisitor;
import org.zanata.client.config.LocaleMapping;
import org.zanata.common.LocaleId;
import org.zanata.rest.StringSet;
import org.zanata.rest.dto.resource.Resource;
import org.zanata.rest.dto.resource.TranslationsResource;

public abstract class AbstractGettextPushStrategy extends AbstractPushStrategy {
    private PoReader2 poReader = new PoReader2();
    protected Set<String> localSrcDocNames;

    public AbstractGettextPushStrategy() {
        super(new StringSet("comment;gettext"), ".pot");
    }

    /**
     * Warn the user if they have selected project type 'podir' and the path
     * contains 'pot/'. If 'pot/' is present in the source directory field, it
     * is likely that the user has entered the translation directory by mistake.
     */
    protected void checkSrcFileNames(String projectType, String[] srcFiles, boolean isInteractive) {
    }

    public Set<String> findDocNames(File srcDir, ImmutableList<String> includes, ImmutableList<String> excludes,
            boolean useDefaultExclude, boolean caseSensitive, boolean excludeLocaleFilenames) throws IOException {
        if (localSrcDocNames != null) {
            return localSrcDocNames;
        }
        localSrcDocNames = new HashSet<>();

        // populate localDocNames by looking in pot directory, ignore
        // excludeLocale option
        String[] srcFiles = getSrcFiles(srcDir, includes, excludes, false, useDefaultExclude, caseSensitive);

        for (String potName : srcFiles) {
            String docName = removeExtension(potName);
            localSrcDocNames.add(docName);
        }
        checkSrcFileNames(getOpts().getProjectType(), srcFiles, getOpts().isInteractiveMode());
        return localSrcDocNames;
    }

    protected Set<String> getSrcDocNames() {
        try {
            return findDocNames(getOpts().getSrcDir(), getOpts().getIncludes(), getOpts().getExcludes(),
                    getOpts().getDefaultExcludes(), getOpts().getCaseSensitive(),
                    getOpts().getExcludeLocaleFilenames());
        } catch (IOException e) {
            throw new RuntimeException(e);
        }
    }

    /**
     * Try to find locales based on translation files found on local file
     * system. It will be called for each source document in a loop.
     *
     * @return a list of locale mapping that potentially has translation files
     * @param srcDocName
     *            source document name
     */
    abstract Collection<LocaleMapping> findLocales(String srcDocName);

    protected File getTransFile(LocaleMapping locale, String docName) {
        File transFile = new TransFileResolver(getOpts()).getTransFile(DocNameWithoutExt.from(docName), locale);
        return transFile;
    }

    @Override
    public Resource loadSrcDoc(File sourceDir, String docName) throws IOException {
        File srcFile = new File(sourceDir, docName + getFileExtension());
        try (FileInputStream fileInputStream = new FileInputStream(srcFile);
                BufferedInputStream bis = new BufferedInputStream(fileInputStream)) {
            InputSource potInputSource = new InputSource(bis);
            potInputSource.setEncoding("utf8");
            // load 'srcDoc' from pot/${docID}.pot
            return getPoReader().extractTemplate(potInputSource, new LocaleId(getOpts().getSourceLang()), docName);
        }
    }

    @Override
    public void visitTranslationResources(String srcDocName, Resource srcDoc, TranslationResourcesVisitor callback)
            throws IOException {
        for (LocaleMapping locale : findLocales(srcDocName)) {
            File transFile = getTransFile(locale, srcDocName);
            if (transFile.canRead()) {
                try (BufferedInputStream bis = new BufferedInputStream(new FileInputStream(transFile))) {
                    InputSource inputSource = new InputSource(bis);
                    inputSource.setEncoding("utf8");
                    TranslationsResource targetDoc = getPoReader().extractTarget(inputSource);
                    callback.visit(locale, targetDoc);
                }
            }
        }
    }

    protected PoReader2 getPoReader() {
        return poReader;
    }

}