alfresco-community-repo/source/java/org/alfresco/repo/action/ActionTrackingServiceImpl.java

/*
 * Copyright (C) 2005-2010 Alfresco Software Limited.
 *
 * This file is part of Alfresco
 *
 * Alfresco 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 3 of the License, or
 * (at your option) any later version.
 *
 * Alfresco 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 Alfresco. If not, see <http://www.gnu.org/licenses/>.
 */
package org.alfresco.repo.action;

import java.net.InetAddress;
import java.net.UnknownHostException;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Date;
import java.util.List;
import java.util.StringTokenizer;

import org.alfresco.repo.cache.EhCacheAdapter;
import org.alfresco.repo.security.authentication.AuthenticationUtil;
import org.alfresco.repo.security.authentication.AuthenticationUtil.RunAsWork;
import org.alfresco.repo.transaction.AlfrescoTransactionSupport;
import org.alfresco.repo.transaction.TransactionListenerAdapter;
import org.alfresco.repo.transaction.RetryingTransactionHelper.RetryingTransactionCallback;
import org.alfresco.service.cmr.action.Action;
import org.alfresco.service.cmr.action.ActionStatus;
import org.alfresco.service.cmr.action.ActionTrackingService;
import org.alfresco.service.cmr.action.CancellableAction;
import org.alfresco.service.cmr.action.ExecutionDetails;
import org.alfresco.service.cmr.action.ExecutionSummary;
import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.service.transaction.TransactionService;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

/**
 * Action execution tracking service implementation
 * 
 * @author Nick Burch
 */
public class ActionTrackingServiceImpl implements ActionTrackingService 
{
   /**
    * The logger
    */
   private static Log logger = LogFactory.getLog(ActionTrackingServiceImpl.class);

   private EhCacheAdapter<String, ExecutionDetails> executingActionsCache;
   
   private TransactionService transactionService;
   private RuntimeActionService runtimeActionService;
   
   /**
    * Doesn't need to be cluster unique, is just used
    *  to try to reduce the chance of clashes in the 
    *  quickest and easiest way.
    */
   private short nextExecutionId = 1;
   private short wrapExecutionIdAfter = Short.MAX_VALUE/2;
   
   /** How we separate bits of the cache key */
   private static final char cacheKeyPartSeparator = '=';
   
   /**
    * Set the transaction service
    * 
    * @param transactionService the transaction service
    */
   public void setTransactionService(TransactionService transactionService)
   {
       this.transactionService = transactionService;
   }

   /**
    * Set the runtime action service
    * 
    * @param runtimeActionService the runtime action service
    */
   public void setRuntimeActionService(RuntimeActionService runtimeActionService)
   {
       this.runtimeActionService = runtimeActionService;
   }
   
   /**
    * Sets the cache used to store details of
    *  currently executing actions, cluster wide.
    */
   public void setExecutingActionsCache(EhCacheAdapter<String, ExecutionDetails> executingActionsCache)
   {
       this.executingActionsCache = executingActionsCache;
   }
   
   
   /** Used by unit tests only */
   protected void resetNextExecutionId() {
      this.nextExecutionId = 1;
   }
   
   
   public void recordActionPending(Action action) 
   {
      recordActionPending((ActionImpl)action);
   }
   public void recordActionPending(ActionImpl action)
   {
      // Set the status
      action.setExecutionStatus(ActionStatus.Pending);
      
      // Have it put into the cache, so we can tell it
      //  is waiting to be run
      placeActionInCache(action);
   }
   
   public void recordActionComplete(Action action) 
   {
      recordActionComplete((ActionImpl)action);
   }
   private void recordActionComplete(ActionImpl action)
   {
      if (logger.isDebugEnabled() == true)
      {
         logger.debug("Action " + action + " has completed execution");
      }
      
      // Mark it as having worked
      action.setExecutionEndDate(new Date());
      action.setExecutionStatus(ActionStatus.Completed);
      action.setExecutionFailureMessage(null);
      if(action.getNodeRef() != null)
      {
         runtimeActionService.saveActionImpl(action.getNodeRef(), action);
      }
      
      // Remove it from the cache, as it's finished
      String key = generateCacheKey(action);
      executingActionsCache.remove(key);
   }

   public void recordActionExecuting(Action action) 
   {
      recordActionExecuting((ActionImpl)action);
   }
   private void recordActionExecuting(ActionImpl action)
   {
      if (logger.isDebugEnabled() == true)
      {
         logger.debug("Action " + action + " has begun exection");
      }
      
      // Grab what status it was before
      ActionStatus previousStatus = action.getExecutionStatus();
      
      // Mark the action as starting
      action.setExecutionStartDate(new Date());
      action.setExecutionStatus(ActionStatus.Running);
    
      // If it's a synchronous execution, put it into the cache
      if(previousStatus != ActionStatus.Pending)
      {
         placeActionInCache(action);
      }
      else
      {
         // If it's async, update the existing cache entry
         String key = generateCacheKey(action); 
         ExecutionDetails details = executingActionsCache.get(key);
         
         // Check it's really there, warn + fix if not
         if(details == null) {
            logger.warn(
                  "Went to mark the start of execution of " +
                  action + " but it wasn't in the running actions cache! " +
                  "Your running actions cache is probably too small"
            );
         }
         
         // Update and save into the cache
         details = buildExecutionDetails(action);
         executingActionsCache.put(key, details);
      }
   }
   
   /**
    * For an action that needs to go into the cache
    *  (async action that is pending, or sync action
    *  that is running), assign an execution instance
    *  and put into the cache
    */
   private void placeActionInCache(ActionImpl action)
   {
      // Assign it a (unique) execution ID
      // (Keep checking to see if the key is used as we
      //  increase nextExecutionId until it isn't)
      String key = null;
      boolean assigned = false;
      while(!assigned) {
         // Try
         action.setExecutionInstance(nextExecutionId++);
         key = generateCacheKey(action);
         
         // Is it ok?
         if(executingActionsCache.get(key) == null) {
            assigned = true;
         }
         
         // Do we need to wrap?
         // (Wrap before absolutely needed, makes things simpler)
         if(nextExecutionId > wrapExecutionIdAfter) {
            synchronized (this) {
               while(nextExecutionId > wrapExecutionIdAfter) {
                  nextExecutionId -= wrapExecutionIdAfter;
               }
            }
         }
      }
      
      // Put it into the cache
      ExecutionDetails details = buildExecutionDetails(action);
      executingActionsCache.put(key, details);
   }

   /**
    * Schedule the recording of the action failure to occur
    *  in another transaction
    */
   public void recordActionFailure(Action action, Throwable exception)
   {
      if (logger.isDebugEnabled() == true)
      {
         if(exception instanceof ActionCancelledException)
         {
            logger.debug("Will shortly record completed cancellation of action " + action);
         }
         else
         {
            logger.debug("Will shortly record failure of action " + action + " due to " + exception.getMessage());
         }
      }
      
      // Record when it finished
      ((ActionImpl)action).setExecutionEndDate(new Date());
      
      // Record it as Failed or Cancelled, depending on the exception
      if(exception instanceof ActionCancelledException)
      {
         ((ActionImpl)action).setExecutionStatus(ActionStatus.Cancelled);
         ((ActionImpl)action).setExecutionFailureMessage(null);
      }
      else
      {
         ((ActionImpl)action).setExecutionStatus(ActionStatus.Failed);
         ((ActionImpl)action).setExecutionFailureMessage(exception.getMessage());
      }
      
      // Remove it from the cache, as it's no longer running
      String key = generateCacheKey(action);
      executingActionsCache.remove(key);

      // Do we need to update the persisted details?
      if(action.getNodeRef() != null)
      {
         // Take a local copy of the details
         // (That way, if someone has a reference to the
         //  action and plays with it, we still save the
         //  correct information)
         final String actionId = action.getId();
         final Date startedAt = action.getExecutionStartDate();
         final Date endedAt = action.getExecutionEndDate();
         final String message = action.getExecutionFailureMessage();
         final NodeRef actionNode = action.getNodeRef();
         
         // Have the details updated on the action as soon
         //  as the transaction has finished rolling back
         AlfrescoTransactionSupport.bindListener(
            new TransactionListenerAdapter() {
               public void afterRollback()
               {
                  transactionService.getRetryingTransactionHelper().doInTransaction(
                      new RetryingTransactionCallback<Object>()
                      {
                         public Object execute() throws Throwable
                         {
                            // Update the action as the system user
                            return AuthenticationUtil.runAs(new RunAsWork<Action>() {
                               public Action doWork() throws Exception
                               {
                                  // Grab the latest version of the action
                                  ActionImpl action = (ActionImpl)
                                     runtimeActionService.createAction(actionNode);
                                  
                                  // Update it
                                  action.setExecutionStartDate(startedAt);
                                  action.setExecutionEndDate(endedAt);
                                  action.setExecutionStatus(ActionStatus.Failed);
                                  action.setExecutionFailureMessage(message);
                                  runtimeActionService.saveActionImpl(actionNode, action);
                                  
                                  if (logger.isDebugEnabled() == true)
                                  {
                                     logger.debug("Recorded failure of action " + actionId + ", node " + actionNode + " due to " + message);
                                  }
                                  
                                  // All done
                                  return action;
                               }
                            }, AuthenticationUtil.SYSTEM_USER_NAME);
                         }
                      }, false, true
                  );
               }
            }
         );
      }
   }

   public boolean isCancellationRequested(CancellableAction action) 
   {
      // If the action isn't in the cache, but is of
      //  status executing, then put it back into the
      //  cache and warn
      // (Probably means the cache is too small)
      String key = generateCacheKey(action);
      ExecutionDetails details = getExecutionDetails(buildExecutionSummary(key));
      if(details == null) {
         logger.warn(
               "Unable to check cancellation status for running action " +
               action + " as it wasn't in the running actions cache! " +
               "Your running actions cache is probably too small"
         );
         
         // Re-generate
         details = buildExecutionDetails(action);
         
         // Re-save into the cache, so it's there for
         //  next time
         executingActionsCache.put(key, details);
      }
      
      // Check the cached details, and see if cancellation
      //  has been requested
      return details.isCancelRequested();
   }

   public void requestActionCancellation(CancellableAction action) 
   {
      requestActionCancellation(
            generateCacheKey(action)
      );
   }
   
   public void requestActionCancellation(ExecutionSummary executionSummary) 
   {
      requestActionCancellation(
            generateCacheKey(executionSummary)
      );
   }
   
   private void requestActionCancellation(String actionKey)
   {
      // See if the action is in the cache
      ExecutionDetails details = executingActionsCache.get(actionKey);
      
      if(details == null) {
         // It isn't in the cache, so nothing to do
         return;
      }
      
      // Since it is, update the cancelled flag on it
      details.requestCancel();
      
      // Save the flag to the cache
      executingActionsCache.put(actionKey, details);
   }

   
   public List<ExecutionSummary> getAllExecutingActions() {
      Collection<String> actions = executingActionsCache.getKeys();
      List<ExecutionSummary> details = new ArrayList<ExecutionSummary>(actions.size());
      for(String key : actions) {
         details.add( buildExecutionSummary(key) );
      }
      return details;
   }

   public List<ExecutionSummary> getExecutingActions(Action action) {
      Collection<String> actions = executingActionsCache.getKeys();
      List<ExecutionSummary> details = new ArrayList<ExecutionSummary>();
      String match = action.getActionDefinitionName() + cacheKeyPartSeparator + 
                     action.getId() + cacheKeyPartSeparator;
      for(String key : actions) {
         if(key.startsWith(match)) {
            details.add( buildExecutionSummary(key) );
         }
      }
      return details;
   }

   public List<ExecutionSummary> getExecutingActions(String type) {
      Collection<String> actions = executingActionsCache.getKeys();
      List<ExecutionSummary> details = new ArrayList<ExecutionSummary>();
      String match = type + cacheKeyPartSeparator;
      for(String key : actions) {
         if(key.startsWith(match)) {
            details.add( buildExecutionSummary(key) );
         }
      }
      return details;
   }

   public ExecutionDetails getExecutionDetails(ExecutionSummary executionSummary) {
      ExecutionDetails details = executingActionsCache.get(
            generateCacheKey(executionSummary)
      );
      if(details != null) {
         details.setExecutionSummary(executionSummary);
      }
      return details;
   }

   /**
    * Generates the cache key for the specified action.
    */
   protected static String generateCacheKey(Action action)
   {
      return 
         action.getActionDefinitionName() + cacheKeyPartSeparator +
         action.getId() + cacheKeyPartSeparator +
         ((ActionImpl)action).getExecutionInstance()
      ;
   }
   protected static String generateCacheKey(ExecutionSummary summary)
   {
      return 
         summary.getActionType() + cacheKeyPartSeparator +
         summary.getActionId() + cacheKeyPartSeparator +
         summary.getExecutionInstance()
      ;
   }
   
   /**
    * Builds up the details to be stored in a cache
    *  for a specific action
    */
   protected static ExecutionDetails buildExecutionDetails(Action action)
   {
      // Where are we running?
      if(machineName == null) {
         try {
            InetAddress localhost = InetAddress.getLocalHost();
            machineName = localhost.getHostAddress() + " : " +
               localhost.getHostName();
         } catch(UnknownHostException e) {
            machineName = "(machine details unavailable - server IP not known)";
         }
      }
      
      // Generate
      return new ExecutionDetails(
            buildExecutionSummary(action),
            action.getNodeRef(), machineName,
            action.getExecutionStartDate(), false
      );
   }
   private static String machineName = null;

   /**
    * Turns a cache key back into its constituent
    *  parts, for easier access.
    */
   protected static ExecutionSummary buildExecutionSummary(String key)
   {
      StringTokenizer st = new StringTokenizer(key, new String(new char[]{cacheKeyPartSeparator}));
      String actionType = st.nextToken();
      String actionId = st.nextToken();
      int executionInstance = Integer.parseInt(st.nextToken());
      
      return new ExecutionSummary(actionType, actionId, executionInstance);
   }
   protected static ExecutionSummary buildExecutionSummary(Action action)
   {
      return new ExecutionSummary(
            action.getActionDefinitionName(),
            action.getId(),
            ((ActionImpl)action).getExecutionInstance()
      );
   }
}