/*
  Copyright (C) 2008 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.ofs.htaccess.eval;

import java.util.Map;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.opengroupware.jope.foundation.NSKeyValueCoding;
import org.opengroupware.jope.foundation.NSKeyValueCodingAdditions;
import org.opengroupware.jope.foundation.NSObject;
import org.opengroupware.jope.foundation.UObject;
import org.opengroupware.jope.ofs.htaccess.HtConfigBuilder;
import org.opengroupware.jope.ofs.htaccess.HtConfigDirective;
import org.opengroupware.jope.ofs.htaccess.IHtConfigContainer;
import org.opengroupware.jope.ofs.htaccess.IHtConfigEvaluation;

/**
 * <Limit method [method] ... > ... </Limit>
 * <p>
 * Example:<pre>
 *   &lt;Limit PUT DELETE PROPFIND&gt;
 *     Require valid-user
 *   &lt;/Limit&gt;</pre>
 * 
 * <p>
 * This section directive only executes its contained directives if the
 * <code>context.request.method</code> or <code>method</code> key
 * of the lookup context matches one of the arguments.
 * <br>
 * Note: the operation is case sensitive!
 */
public class Limit extends NSObject implements IHtConfigEvaluation {
  protected static final Log log = LogFactory.getLog("JoConfig");
  
  public Exception evaluateDirective
    (final HtConfigBuilder _builder, HtConfigDirective _directive,
     final Map<String, Object> _cfg, final Object _lookupCtx)
  {
    String method = (String)
      NSKeyValueCoding.Utility.valueForKey(_lookupCtx, "method");
    if (UObject.isEmpty(method)) {
      method = (String)NSKeyValueCodingAdditions.Utility
        .valueForKeyPath(_lookupCtx, "context.request.method");
    }
    
    if (UObject.isEmpty(method)) {
      log.warn("lookup context contains no HTTP method: " + _lookupCtx);
      return null; /* nothing to be done, contents can't match */
    }
    
    String[] args = _directive.arguments();
    if (args == null || args.length == 0)
      return null; /* nothing to be done, nothing to match */
    
    for (String arg: args) {
      if (method.equals(arg)) {
        _builder.processChildren(_cfg,
            (IHtConfigContainer)_directive, _lookupCtx);
        return null; /* method matched */
      }
    }
    return null; /* nothing matched */
  }
}