/*****************************************************************************
 * Copyright (C) The Apache Software Foundation. All rights reserved.        *
 * ------------------------------------------------------------------------- *
 * This software is published under the terms of the Apache Software License *
 * version 1.1, a copy of which has been included  with this distribution in *
 * the LICENSE file.                                                         *
 *****************************************************************************/
 package org.apache.cocoon.acting;

import java.util.Map;
import org.apache.cocoon.Constants;
import org.apache.cocoon.environment.Redirector;
import org.apache.cocoon.environment.SourceResolver;
import org.apache.avalon.framework.parameters.Parameters;
import org.apache.cocoon.acting.*;
import org.apache.cocoon.environment.Cookie;
import org.apache.cocoon.environment.Response;
import org.apache.cocoon.environment.ObjectModelHelper;
/**
 * The CookieCreatorAction class create or remove cookies.
 * The action needs these parameters:
 *
 * <dl>
 *   <dt>name</dt>
 *   <dd>the cookie name</dd>
 *   <dt>value</dt>
 *   <dd>the cookie value</dd>
 *   <dt>comment</dt>
 *   <dd>a comment to the cookie</dd>
 *   <dt>domain</dt>
 *   <dd>the domain the cookie is sent to</dd>
 *   <dt>path</dt>
 *   <dd>the path of the domain the cookie is sent to</dd>
 *   <dt>secure</dt>
 *   <dd>use a secure transport protocol (default is false)</dd>
 *   <dt>maxage</dt>
 *   <dd>Age in seconds. Use -1 to remove cookie. (default is 0; cookie lives
 *   within the session and it is not stored)</dd>
 *   <dt>version</dt>
 *   <dd>version of cookie(default is 0)</dd>
 * </dl>
 *
 * If you want to set a cookie you only need to specify the cookie name.
 * Its value is an empty string as default. The maxage is 0 that means the
 * cookie will live until the session is invalidated.
 *
 * If you want to remove a cookie set its maxage to -1.
 *
 * @author Paolo Scaffardi &lt;paolo@arsenio.net&gt;
 * @version CVS $Revision: 1.0.0.0 $ $Date: 2001/10/18 12:00:00 $
 */

public class CookieCreatorAction extends ComposerAction {

  public Map act(Redirector redirector, SourceResolver resolver, Map objectModel, String src, Parameters parameters) throws java.lang.Exception {

    Response res = ObjectModelHelper.getResponse(objectModel);

    /* check response validity */
    if (res == null) {
      getLogger().debug ("COOKIECREATOR: no response object");
      return null;
    }

    String 	cookieName = null,
        	cookieValue = null,
                cookieComment = null,
	    	cookieDomain = null,
        	cookiePath = null;

    try {
        cookieName = parameters.getParameter("name");
        }
    catch (Exception e) {
      getLogger().debug("COOKIECREATOR: cannot retrieve cookie name attribute");
      return null;
      }

   cookieValue = parameters.getParameter("value","");

   Cookie cookie = res.createCookie(cookieName, cookieValue) ;

   try {
        if ((cookieComment = parameters.getParameter("comment")) != null)
          cookie.setComment(cookieComment);
    }
    catch (org.apache.avalon.framework.parameters.ParameterException pe) {
    }

    try {
        if ((cookieDomain = parameters.getParameter("domain")) != null)
          cookie.setDomain(cookieDomain);
    }
    catch (org.apache.avalon.framework.parameters.ParameterException pe) {
    }

    try {
        if ((cookiePath = parameters.getParameter("path")) != null)
          cookie.setPath(cookiePath);
    }
    catch (org.apache.avalon.framework.parameters.ParameterException pe) {
    }

    cookie.setSecure(parameters.getParameterAsBoolean("secure",false)) ;
    cookie.setMaxAge(parameters.getParameterAsInteger("maxage",0));
    cookie.setVersion(parameters.getParameterAsInteger("version",0));

    res.addCookie (cookie);

    if (cookie.getMaxAge() == 0)
      getLogger().debug("COOKIECREATOR: '" + cookieName + "' cookie has been removed");
    else
      getLogger().debug("COOKIECREATOR: '" + cookieName + "' cookie created with value '"
        +  cookieValue +"' (version "+ cookie.getVersion() + "; it will expire in "
        + cookie.getMaxAge()+" seconds)");

    return null ;
  }
}