com.caucho.server.webbeans.ConversationContext Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 1998-2018 Caucho Technology -- all rights reserved
 *
 * This file is part of Resin(R) Open Source
 *
 * Each copy or derived work must preserve the copyright notice and this
 * notice unmodified.
 *
 * Resin Open Source is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * Resin Open Source 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, or any warranty
 * of NON-INFRINGEMENT.  See the GNU General Public License for more
 * details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Resin Open Source; if not, write to the
 *
 *   Free Software Foundation, Inc.
 *   59 Temple Place, Suite 330
 *   Boston, MA 02111-1307  USA
 *
 * @author Scott Ferguson
 */

package com.caucho.server.webbeans;

import java.lang.annotation.Annotation;
import java.util.HashMap;
import java.util.Map;
import java.util.logging.Level;
import java.util.logging.Logger;

import javax.enterprise.context.Conversation;
import javax.enterprise.context.ConversationScoped;
import javax.faces.context.ExternalContext;
import javax.faces.context.FacesContext;
import javax.servlet.ServletRequest;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpSession;
import javax.servlet.http.HttpSessionBindingEvent;
import javax.servlet.http.HttpSessionBindingListener;

import com.caucho.config.scope.AbstractScopeContext;
import com.caucho.config.scope.ContextContainer;
import com.caucho.config.scope.ScopeRemoveListener;
import com.caucho.server.dispatch.ServletInvocation;
import com.caucho.util.L10N;
import com.caucho.util.RandomUtil;

/**
 * The conversation scope value
 */
@SuppressWarnings("serial")
public class ConversationContext extends AbstractScopeContext
  implements Conversation, java.io.Serializable
{
  private static final Logger log = Logger.getLogger(ConversationContext.class.getName());
  private static final L10N L = new L10N(ConversationContext.class);
  
  private static final String SESSION_CONVERSATION = "caucho.session.conversation";
  private static final String SESSION_CONVERSATION_ID = "caucho.session.conversation.id";
  private static final String REQUEST_CONVERSATION = "caucho.request.conversation";
  
  private static final long DEFAULT_TIMEOUT = 120000L;
  
  public ConversationContext()
  {
  }
  
  /**
   * Returns true if the scope is currently active.
   */
  @Override
  public boolean isActive()
  {
    FacesContext facesContext = FacesContext.getCurrentInstance();

    if (facesContext != null)
      return true;
    
    if (isSessionScope())
      return true;
    
    return false;
  }

  @Override
  public boolean isTransient()
  {
    Scope scope = getConversationScope();
    
    return scope == null || scope._extendedId == null;
  }

  /**
   * Returns the scope annotation type.
   */
  public Class getScope()
  {
    return ConversationScoped.class;
  }

  /**
   * Returns the current value of the component in the conversation scope.
   */
  @Override
  protected ContextContainer getContextContainer()
  {
    Scope scope = getConversationScope();
    
    if (scope != null)
      return scope._transientConversation;
    else
      return null;
  }

  /**
   * Returns the current value of the component in the conversation scope.
   */
  @Override
  protected ContextContainer createContextContainer()
  {
    Scope scope = createConversationScope();

    if (scope._transientConversation == null) {
      scope._transientConversation = new ContextContainer();
    }
    
    return scope._transientConversation;
  }

  //
  // Conversation API
  //

  /**
   * Begins an extended conversation
   */
  @Override
  public void begin()
  {
    StringBuilder sb = new StringBuilder();
    
    sb.append(RandomUtil.getRandomLong() & 0x7fffffffffffffffL);

    begin(sb.toString());
  }
  
  @Override
  public void begin(String name)
  {
    Scope scope = createConversationScope(name);
    
    if (scope._extendedId != null)
      throw new IllegalStateException(L.l("Conversation begin() must only be called when a long-running conversation does not exist."));
    
    FacesContext facesContext = FacesContext.getCurrentInstance();
    
    if (facesContext != null && name != null)
      facesContext.getViewRoot().getAttributes().put("caucho.cid", name);
    
    scope._extendedId = name;
    scope.put(name, scope._transientConversation);
  }

  /**
   * Ends an extended conversation
   */
  @Override
  public void end()
  {
    Scope scope = getConversationScope();

    if (scope == null)
      return;
    
    String id = scope._extendedId;
    scope._extendedId = null;

    if (id == null)
      throw new IllegalStateException(L.l("Conversation end() must only be called when a long-running conversation exists."));

    scope.remove(id);
  }

  @Override
  public String getId()
  {
    Scope scope = getConversationScope();
    
    if (scope != null)
      return scope._extendedId;
    else
      return null;
  }

  @Override
  public long getTimeout()
  {
    Scope scope = createConversationScope();
    
    return scope.getTimeout();
  }

  @Override
  public void setTimeout(long timeout)
  {
    try {
      Scope scope = createConversationScope();
    
      scope.setTimeout(timeout);
    } catch (RuntimeException e) {
      log.log(Level.WARNING, e.toString(), e);
    }
  }
  
  public void destroy()
  {
    Scope scope = getConversationScope();
    
    if (scope == null)
      return;
    
    destroy(scope, true);
  }
  
  private void destroy(Scope scope, boolean isClearId)
  {  
    if (scope == null)
      return;
    
    ContextContainer context = scope._transientConversation;
    
    if (isClearId)
      scope._transientConversation = null;
    
    if (scope._extendedId == null)
      context.close();
    
    if (isClearId)
      scope._extendedId = null;
  }
  
  private Scope getConversationScope()
  {
    Scope scope = getJsfScope();
    
    if (scope != null)
      return scope;
    
    return getSessionScope();
  }
  
  private Scope createConversationScope()
  {
    FacesContext facesContext = FacesContext.getCurrentInstance();
    
    if (facesContext != null)
      return createJsfScope();
    
    return createSessionScope();
  }
  
  private Scope createConversationScope(String name)
  {
    FacesContext facesContext = FacesContext.getCurrentInstance();
    
    if (facesContext != null)
      return createJsfScope(name);
    
    return createSessionScope(name);
  }
  
  
  /**
   * Returns the current JSF context if it exists.
   */
  private Scope getJsfScope()
  {
    FacesContext facesContext = FacesContext.getCurrentInstance();
    
    if (facesContext == null)
      return null;
    
    return getJsfScope(facesContext, null, false);
  }
  
  /**
   * Creates a scope for a JSF context.
   */
  private Scope createJsfScope()
  {
    return createJsfScope(null);
  }
  
  /**
   * Creates a scope for a JSF context with the given name.
   */
  private Scope createJsfScope(String name)
  {
    FacesContext facesContext = FacesContext.getCurrentInstance();
    
    if (facesContext == null)
      throw new IllegalStateException(L.l("@ConversationScoped is not available because JSF is not active"));

    return getJsfScope(facesContext, name, true);
  }
    
  private Scope getJsfScope(FacesContext facesContext,
                            String name,
                            boolean isCreate)
  {
    ExternalContext extContext = facesContext.getExternalContext();
    Map sessionMap = extContext.getSessionMap();

    Scope scope = (Scope) sessionMap.get(SESSION_CONVERSATION);
    
    if (scope == null) {
      if (! isCreate)
        return null;
      
      scope = new Scope();
      try {
        sessionMap.put(SESSION_CONVERSATION, scope);
      } catch (Exception e) {
        getSessionScope();
      }
    }
    
    Map requestMap = extContext.getRequestParameterMap();
    String cid = (String) requestMap.get("cid");
    
    if (cid == null) {
      cid = (String) facesContext.getViewRoot().getAttributes().get("caucho.cid");
    }
    
    if (scope._transientConversation != null) {
    }
    else if (cid != null) {
      scope._extendedId = cid;
      scope._transientConversation = scope.get(cid);
      
      if (scope._transientConversation == null) {
        throw new IllegalStateException(L.l("Conversation cid={0} is an unknown conversation",
                                            cid));
      }
    }
    else if (name != null) {
      scope._extendedId = name;
      scope._transientConversation = scope.get(name);
    }
    else if (scope._extendedId != null) {
      scope._transientConversation = scope.get(scope._extendedId);
      
      if (scope._transientConversation == null) {
        throw new IllegalStateException(L.l("Conversation id={0} is an unknown conversation",
                                            scope._extendedId));
      }
    }

    return scope;
  }
  
  private boolean isSessionScope()
  {
    ServletRequest request = ServletInvocation.getContextRequest();

    if (request != null) {
      HttpSession session = ((HttpServletRequest) request).getSession();

      return session != null;
    }
    
    return false;
  }
  
  private Scope getSessionScope()
  {
    ServletRequest request = ServletInvocation.getContextRequest();

    if (request == null)
      return null;
    
    HttpSession session = ((HttpServletRequest) request).getSession();

    if (session == null)
      return null;
    
    Scope scope = (Scope) session.getAttribute(SESSION_CONVERSATION);
    
    if (scope == null)
      return null;
    
    if (scope._transientConversation == null)
      scope._transientConversation = scope.get(scope._extendedId);
    
    return scope;
  }
  
  private Scope createSessionScope()
  {
    ServletRequest request = ServletInvocation.getContextRequest();

    if (request == null)
      return null;
    
    HttpSession session = ((HttpServletRequest) request).getSession();

    if (session == null)
      return null;
    
    Scope scope = (Scope) session.getAttribute(SESSION_CONVERSATION);
    
    if (scope == null) {
      scope = new Scope();
      session.setAttribute(SESSION_CONVERSATION, scope);
    }
    
    request.setAttribute(REQUEST_CONVERSATION, new RequestListener(scope));
    
    return scope;
  }

  /**
   * Creates a conversation scope in the current scope.
   */
  private Scope createSessionScope(String name)
  {
    Scope scope = createSessionScope();
    
    if (scope == null)
      return null;
    
    if (scope._transientConversation != null) {
    }
    else if (name != null) {
      // scope._extendedId = name;
      scope._transientConversation = scope.get(name);
    }
    else if (scope._extendedId != null) {
      scope._transientConversation = scope.get(scope._extendedId);
    
      if (scope._transientConversation == null) {
        throw new IllegalStateException(L.l("Conversation id={0} is an unknown conversation",
                                            scope._extendedId));
      }
    }
    else
      scope._transientConversation = new ContextContainer();
    
    return scope;
  }
 
  @Override
  public String toString()
  {
    return getClass().getSimpleName() + "[]";
  }

  static class Scope implements java.io.Serializable, HttpSessionBindingListener {
    ContextContainer _transientConversation;
    
    String _extendedId;
    
    String _lastId;
    private Map _conversationMap;
    private long _timeout = DEFAULT_TIMEOUT;
    
    public long getTimeout()
    {
      return _timeout;
    }
    
    public void setTimeout(long timeout)
    {
      _timeout = timeout;
    }
    
    public ContextContainer get(String id)
    {
      if (_conversationMap != null)
        return _conversationMap.get(id);
      else
        return null;
    }
    
    public ContextContainer remove(String id)
    {
      if (_conversationMap != null)
        return _conversationMap.remove(id);
      else
        return null;
    }
    
    public void put(String id, ContextContainer container)
    {
      if (_conversationMap == null)
        _conversationMap = new HashMap();
      
      _conversationMap.put(id, container);
    }

    @Override
    public void valueBound(HttpSessionBindingEvent event)
    {
    }

    @Override
    public void valueUnbound(HttpSessionBindingEvent event)
    {
      if (_conversationMap == null)
        return;
      
      for (ContextContainer conversation: _conversationMap.values()) {
        conversation.close();
      }
      
      _conversationMap = null;
    }
  }
  
  class RequestListener implements ScopeRemoveListener {
    private Scope _scope;
    
    RequestListener(Scope scope)
    {
      _scope = scope;
    }
    
    @Override
    public void removeEvent(Object scope, String name)
    {
      destroy(_scope, false);
    }
  }
}