TranslationStateCacheImpl.java

/*
 * Copyright 2010, 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.service.impl;

import java.io.Serializable;
import java.util.Date;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import lombok.AllArgsConstructor;
import lombok.EqualsAndHashCode;
import lombok.Getter;
import net.sf.ehcache.CacheManager;

import org.jboss.seam.Component;
import org.jboss.seam.ScopeType;
import org.jboss.seam.annotations.Create;
import org.jboss.seam.annotations.Destroy;
import org.jboss.seam.annotations.Name;
import org.jboss.seam.annotations.Observer;
import org.jboss.seam.annotations.Scope;
import org.zanata.cache.CacheWrapper;
import org.zanata.cache.EhcacheWrapper;
import org.zanata.common.LocaleId;
import org.zanata.dao.DocumentDAO;
import org.zanata.dao.TextFlowTargetDAO;
import org.zanata.events.TextFlowTargetStateEvent;
import org.zanata.model.HDocument;
import org.zanata.model.HTextFlowTarget;
import org.zanata.service.TranslationStateCache;
import org.zanata.service.ValidationFactoryProvider;
import org.zanata.webtrans.shared.model.DocumentId;
import org.zanata.webtrans.shared.model.DocumentStatus;
import org.zanata.webtrans.shared.model.ValidationAction;
import org.zanata.webtrans.shared.model.ValidationId;

import com.google.common.cache.CacheLoader;

/**
 * Default Implementation of the Translation State Cache.
 *
 * @author Carlos Munoz <a
 *         href="mailto:camunoz@redhat.com">camunoz@redhat.com</a>
 */
@Name("translationStateCacheImpl")
// TODO split into APPLICATION and STATELESS beans
@Scope(ScopeType.APPLICATION)
public class TranslationStateCacheImpl implements TranslationStateCache {
    private static final String BASE = TranslationStateCacheImpl.class
            .getName();
    private static final String DOC_STATUS_CACHE_NAME = BASE
            + ".docStatusCache";
    private static final String TFT_VALIDATION_CACHE_NAME = BASE
            + ".targetValidationCache";

    private CacheManager cacheManager;
    private CacheWrapper<TranslatedDocumentKey, DocumentStatus> docStatusCache;
    private CacheWrapper<Long, Map<ValidationId, Boolean>> targetValidationCache;
    private CacheLoader<TranslatedDocumentKey, DocumentStatus> docStatusLoader;
    private CacheLoader<Long, Map<ValidationId, Boolean>> targetValidationLoader;

    public TranslationStateCacheImpl() {
        // constructor for Seam
        this.docStatusLoader = new HTextFlowTargetIdLoader();
        this.targetValidationLoader = new HTextFlowTargetValidationLoader();
    }

    public TranslationStateCacheImpl(
            CacheLoader<TranslatedDocumentKey, DocumentStatus> docStatsLoader,
            CacheLoader<Long, Map<ValidationId, Boolean>> targetValidationLoader) {
        // constructor for testing
        this.docStatusLoader = docStatsLoader;
        this.targetValidationLoader = targetValidationLoader;
    }

    @Create
    public void create() {
        cacheManager = CacheManager.create();
        docStatusCache =
                EhcacheWrapper.create(DOC_STATUS_CACHE_NAME, cacheManager,
                        docStatusLoader);
        targetValidationCache =
                EhcacheWrapper.create(TFT_VALIDATION_CACHE_NAME, cacheManager,
                        targetValidationLoader);
    }

    @Destroy
    public void destroy() {
        cacheManager.shutdown();
    }

    /**
     * This method contains all logic to be run immediately after a Text Flow
     * Target has been successfully translated.
     */
    @Observer(TextFlowTargetStateEvent.EVENT_NAME)
    @Override
    public void textFlowStateUpdated(TextFlowTargetStateEvent event) {
        // updateDocStatusCache(event.getDocumentId(), event.getLocaleId(),
        // event.getTextFlowTargetId());

        // TODO enhance TextFlowTargetStateEvent and update this cache directly
        // (no database I/O) rather than invalidating
        invalidateDocLastTranslatedCache(event.getDocumentId(),
                event.getLocaleId());
        invalidateTargetValidationCache(event.getTextFlowTargetId());
    }

    @Override
    public DocumentStatus getDocumentStatus(Long documentId, LocaleId localeId) {
        return docStatusCache.getWithLoader(new TranslatedDocumentKey(
                documentId, localeId));
    }

    private void invalidateDocLastTranslatedCache(Long documentId,
            LocaleId localeId) {
        docStatusCache.remove(new TranslatedDocumentKey(documentId, localeId));
    }

    @Override
    public Boolean textFlowTargetHasWarningOrError(Long targetId,
            ValidationId validationId) {
        Map<ValidationId, Boolean> cacheEntry =
                targetValidationCache.getWithLoader(targetId);
        synchronized (cacheEntry) {
            if (!cacheEntry.containsKey(validationId)) {
                Boolean result = loadTargetValidation(targetId, validationId);
                cacheEntry.put(validationId, result);
            }
            return cacheEntry.get(validationId);
        }
    }

    private void updateDocStatusCache(Long documentId, LocaleId localeId,
            Long updatedTargetId) {
        DocumentStatus documentStatus =
                docStatusCache.get(new TranslatedDocumentKey(documentId,
                        localeId));
        TextFlowTargetDAO textFlowTargetDAO = getTextFlowTargetDAO();
        HTextFlowTarget target =
                textFlowTargetDAO.findById(updatedTargetId, false);
        updateDocumentStatus(getDocumentDAO(), documentStatus, documentId, localeId, target);
    }

    DocumentDAO getDocumentDAO() {
        return (DocumentDAO) Component.getInstance(DocumentDAO.class);
    }

    TextFlowTargetDAO getTextFlowTargetDAO() {
        TextFlowTargetDAO textFlowTargetDAO = (TextFlowTargetDAO) Component.getInstance(TextFlowTargetDAO.class);
        return textFlowTargetDAO;
    }

    private void invalidateTargetValidationCache(Long textFlowTargetId) {
        targetValidationCache.remove(textFlowTargetId);
    }

    private static class HTextFlowTargetIdLoader extends
            CacheLoader<TranslatedDocumentKey, DocumentStatus> {
        DocumentDAO getDocumentDAO() {
            return (DocumentDAO) Component.getInstance(DocumentDAO.class);
        }

        @Override
        public DocumentStatus load(TranslatedDocumentKey key) throws Exception {
            DocumentDAO documentDAO = getDocumentDAO();
            HTextFlowTarget target =
                    documentDAO.getLastTranslatedTarget(key.getDocumentId(),
                            key.getLocaleId());
            DocumentStatus documentStatus = new DocumentStatus();

            return updateDocumentStatus(documentDAO, documentStatus, key.getDocumentId(),
                    key.getLocaleId(), target);
        }
    }

    private static class HTextFlowTargetValidationLoader extends
            CacheLoader<Long, Map<ValidationId, Boolean>> {
        @Override
        public Map<ValidationId, Boolean> load(Long key) throws Exception {
            return new HashMap<ValidationId, Boolean>();
        }
    }

    private Boolean loadTargetValidation(Long textFlowTargetId,
            ValidationId validationId) {
        TextFlowTargetDAO textFlowTargetDAO = getTextFlowTargetDAO();
        HTextFlowTarget tft =
                textFlowTargetDAO.findById(textFlowTargetId, false);

        if (tft != null) {
            ValidationAction action =
                    ValidationFactoryProvider.getFactoryInstance()
                            .getValidationAction(validationId);
            List<String> errorList =
                    action.validate(tft.getTextFlow().getContents().get(0), tft
                            .getContents().get(0));
            return !errorList.isEmpty();
        }
        return null;
    }

    private static DocumentStatus updateDocumentStatus(DocumentDAO documentDAO,
            DocumentStatus documentStatus, Long documentId, LocaleId localeId,
            HTextFlowTarget target) {
        Date lastTranslatedDate = null;
        String lastTranslatedBy = "";

        if (target != null) {
            lastTranslatedDate = target.getLastChanged();

            if (target.getLastModifiedBy() != null) {
                lastTranslatedBy =
                        target.getLastModifiedBy().getAccount().getUsername();
            }
        }
        HDocument document = documentDAO.findById(documentId, false);
        documentStatus.update(
                new DocumentId(document.getId(), document.getDocId()),
                lastTranslatedDate, lastTranslatedBy);
        return documentStatus;
    }

    @AllArgsConstructor
    @EqualsAndHashCode
    public static final class TranslatedDocumentKey implements Serializable {
        private static final long serialVersionUID = 1L;

        @Getter
        private Long documentId;

        @Getter
        private LocaleId localeId;
    }
}