rhbz804871 - RPC for translation history

zanata-war/src/main/java/org/zanata/dao/AbstractDAOImpl.java

@@ -39,7 +39,9 @@ public void setSession(Session s)
    protected Session getSession()
    {
       if (session == null)
+      {
          throw new IllegalStateException("Session has not been set on DAO before usage");
+      }
       return session;
    }
 
@@ -54,9 +56,13 @@ public T findById(ID id, boolean lock)
    {
       T entity;
       if (lock)
+      {
          entity = (T) getSession().load(getPersistentClass(), id, LockMode.UPGRADE);
+      }
       else
+      {
          entity = (T) getSession().load(getPersistentClass(), id);
+      }
 
       return entity;
    }

zanata-war/src/main/java/org/zanata/webtrans/server/rpc/GetTranslationHistoryHandler.java

@@ -0,0 +1,95 @@
+package org.zanata.webtrans.server.rpc;
+
+import java.text.SimpleDateFormat;
+import java.util.List;
+import java.util.Map;
+
+import org.jboss.seam.ScopeType;
+import org.jboss.seam.annotations.In;
+import org.jboss.seam.annotations.Name;
+import org.jboss.seam.annotations.Scope;
+import org.zanata.dao.TextFlowDAO;
+import org.zanata.exception.ZanataServiceException;
+import org.zanata.model.HLocale;
+import org.zanata.model.HTextFlow;
+import org.zanata.model.HTextFlowTargetHistory;
+import org.zanata.security.ZanataIdentity;
+import org.zanata.service.LocaleService;
+import org.zanata.webtrans.server.ActionHandlerFor;
+import org.zanata.webtrans.shared.model.TransHistoryItem;
+import org.zanata.webtrans.shared.rpc.GetTranslationHistoryAction;
+import org.zanata.webtrans.shared.rpc.GetTranslationHistoryResult;
+
+import com.google.common.base.Function;
+import com.google.common.collect.Collections2;
+import com.google.common.collect.ImmutableList;
+
+import lombok.extern.slf4j.Slf4j;
+import net.customware.gwt.dispatch.server.ExecutionContext;
+import net.customware.gwt.dispatch.shared.ActionException;
+
+/**
+ * @author Patrick Huang <a href="mailto:pahuang@redhat.com">pahuang@redhat.com</a>
+ */
+@Name("webtrans.gwt.GetTranslationHistoryHandler")
+@Scope(ScopeType.STATELESS)
+@ActionHandlerFor(GetTranslationHistoryAction.class)
+@Slf4j
+public class GetTranslationHistoryHandler extends AbstractActionHandler<GetTranslationHistoryAction, GetTranslationHistoryResult>
+{
+   @In
+   ZanataIdentity identity;
+
+   @In
+   LocaleService localeServiceImpl;
+
+   @In
+   TextFlowDAO textFlowDAO;
+
+   @Override
+   public GetTranslationHistoryResult execute(GetTranslationHistoryAction action, ExecutionContext context) throws ActionException
+   {
+      identity.checkLoggedIn();
+      log.debug("get translation history for text flow id {}", action.getTransUnitId());
+
+      HLocale hLocale;
+      try
+      {
+         hLocale = localeServiceImpl.validateLocaleByProjectIteration(action.getWorkspaceId().getLocaleId(), action.getWorkspaceId().getProjectIterationId().getProjectSlug(), action.getWorkspaceId().getProjectIterationId().getIterationSlug());
+      }
+      catch (ZanataServiceException e)
+      {
+         throw new ActionException(e);
+      }
+
+      HTextFlow hTextFlow = textFlowDAO.findById(action.getTransUnitId().getId(), false);
+
+      Map<Integer,HTextFlowTargetHistory> history = hTextFlow.getTargets().get(hLocale.getId()).getHistory();
+
+
+      List<TransHistoryItem> historyItems = ImmutableList.copyOf(Collections2.transform(history.values(), new TargetHistoryToTransHistoryItemFunction()));
+      return new GetTranslationHistoryResult(historyItems);
+   }
+
+   @Override
+   public void rollback(GetTranslationHistoryAction action, GetTranslationHistoryResult result, ExecutionContext context) throws ActionException
+   {
+   }
+
+   private static class TargetHistoryToTransHistoryItemFunction implements Function<HTextFlowTargetHistory, TransHistoryItem>
+   {
+      private final SimpleDateFormat dateFormat;
+
+      public TargetHistoryToTransHistoryItemFunction()
+      {
+         this.dateFormat = new SimpleDateFormat();
+      }
+
+      @Override
+      public TransHistoryItem apply(HTextFlowTargetHistory targetHistory)
+      {
+         return new TransHistoryItem(targetHistory.getVersionNum(), targetHistory.getContents(), targetHistory.getState(), targetHistory.getLastModifiedBy().getName(), dateFormat.format(targetHistory.getLastChanged()));
+
+      }
+   }
+}

zanata-war/src/main/java/org/zanata/webtrans/shared/model/TransHistoryItem.java

@@ -0,0 +1,57 @@
+package org.zanata.webtrans.shared.model;
+
+import java.util.List;
+
+import org.zanata.common.ContentState;
+import com.google.gwt.user.client.rpc.IsSerializable;
+
+/**
+ * @author Patrick Huang <a href="mailto:pahuang@redhat.com">pahuang@redhat.com</a>
+ */
+public class TransHistoryItem implements IsSerializable
+{
+   private Integer versionNum;
+   private List<String> contents;
+   private ContentState status;
+   private String modifiedBy;
+   private String modifiedDate;
+
+   @SuppressWarnings("unused")
+   private TransHistoryItem()
+   {
+   }
+
+   public TransHistoryItem(Integer versionNum, List<String> contents, ContentState status, String modifiedBy, String modifiedDate)
+   {
+      this.versionNum = versionNum;
+      this.contents = contents;
+      this.status = status;
+      this.modifiedBy = modifiedBy;
+      this.modifiedDate = modifiedDate;
+   }
+
+   public Integer getVersionNum()
+   {
+      return versionNum;
+   }
+
+   public List<String> getContents()
+   {
+      return contents;
+   }
+
+   public ContentState getStatus()
+   {
+      return status;
+   }
+
+   public String getModifiedBy()
+   {
+      return modifiedBy;
+   }
+
+   public String getModifiedDate()
+   {
+      return modifiedDate;
+   }
+}

zanata-war/src/main/java/org/zanata/webtrans/shared/rpc/GetTranslationHistoryAction.java

@@ -0,0 +1,26 @@
+package org.zanata.webtrans.shared.rpc;
+
+import org.zanata.webtrans.shared.model.TransUnitId;
+
+/**
+ * @author Patrick Huang <a href="mailto:pahuang@redhat.com">pahuang@redhat.com</a>
+ */
+public class GetTranslationHistoryAction extends AbstractWorkspaceAction<GetTranslationHistoryResult>
+{
+   private TransUnitId transUnitId;
+
+   public GetTranslationHistoryAction(TransUnitId transUnitId)
+   {
+      this.transUnitId = transUnitId;
+   }
+
+   @SuppressWarnings("unused")
+   private GetTranslationHistoryAction()
+   {
+   }
+
+   public TransUnitId getTransUnitId()
+   {
+      return transUnitId;
+   }
+}

zanata-war/src/main/java/org/zanata/webtrans/shared/rpc/GetTranslationHistoryResult.java

@@ -0,0 +1,33 @@
+package org.zanata.webtrans.shared.rpc;
+
+import java.util.List;
+
+import org.zanata.webtrans.shared.model.TransHistoryItem;
+
+import com.google.common.collect.Lists;
+
+import net.customware.gwt.dispatch.shared.Result;
+
+/**
+ * @author Patrick Huang <a href="mailto:pahuang@redhat.com">pahuang@redhat.com</a>
+ */
+public class GetTranslationHistoryResult implements DispatchResult
+{
+   private List<TransHistoryItem> historyItems = Lists.newArrayList();
+
+
+   @SuppressWarnings("unused")
+   private GetTranslationHistoryResult()
+   {
+   }
+
+   public GetTranslationHistoryResult(List<TransHistoryItem> historyItems)
+   {
+      this.historyItems = historyItems;
+   }
+
+   public List<TransHistoryItem> getHistoryItems()
+   {
+      return historyItems;
+   }
+}