/*
  Copyright (C) 2007 Helge Hess

  This file is part of JOPE.

  JOPE 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, or (at your option) any
  later version.

  JOPE 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 JOPE; see the file COPYING.  If not, write to the
  Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
  02111-1307, USA.
*/
package org.opengroupware.jope.appserver.publisher;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.opengroupware.jope.appserver.core.WOComponent;
import org.opengroupware.jope.appserver.core.WOContext;
import org.opengroupware.jope.appserver.core.WODirectAction;
import org.opengroupware.jope.foundation.NSObject;

/*
 * JoActivePageActionInvocation
 * 
 * This is for calling actions bound to a page.
 * 
 * NOTE: this is currently rather useless since a WOComponent is usually NOT
 *       part of the traversal path (JoPageInvocation is).
 * 
 * Eg if you bound a page to an object like:
 * 
 *   -mypage = {
 *     pageName = "MyPage";
 *   }
 *   
 * and then you want to call a directaction method of MyPage, eg:
 * 
 *   /myObject/-mypage/doIt
 *   
 * Note that the clientObject will be mixed up (will point to the page, not to
 * myObject)
 * 
 * TBD: probably we need a 'bind' again?.
 */
public class JoActivePageActionInvocation extends NSObject
  implements IJoCallable
{
  protected static final Log log = LogFactory.getLog("JoClass");
  protected String actionName;
  
  public JoActivePageActionInvocation(String _name) {
    this.actionName = _name;
  }

  /* JoCallable */
  
  public Object callInContext(Object _object, IJoContext _ctx) {
    if (_object == null) {
      log.error("got no page to invoke action on: " + this.actionName);
      return null;
    }

    /* invoke page action */
    
    WOContext ctx = (WOContext)_ctx;
    Object result = null;
    
    if (_object instanceof WOComponent) {
      WOComponent page = (WOComponent)_object;
      
      ctx.setPage(page);
      page.ensureAwakeInContext(ctx);
      ctx.enterComponent(page, null);
      try {
        if (page.shouldTakeValuesFromRequest(ctx.request(), ctx))
          page.takeValuesFromRequest(ctx.request(), ctx);

        /* perform action */

        result = page.performActionNamed(this.actionName);
        if (log.isDebugEnabled())
          log.debug("action returned object: " + result);
      }
      finally {
        ctx.leaveComponent(page);
        ctx.setPage(null);
      }
    }
    else {
      result = WODirectAction.performActionNamed
        (_object, this.actionName, (WOContext)_ctx);
    }
    
    return result;
  }

  public boolean isCallableInContext(IJoContext _ctx) {
    // TBD: we could check whether the clientObject is a WOComponent
    /* we need a WOContext for performAction */
    return _ctx instanceof WOContext;
  }
  
  /* description */
  
  public void appendAttributesToDescription(StringBuilder _d) {
    super.appendAttributesToDescription(_d);
    
    if (this.actionName != null) _d.append(" action=" + this.actionName);
  }
}