/*

   * Licensed to the Apache Software Foundation (ASF) under one or more

   * contributor license agreements.  See the NOTICE file distributed with

   * this work for additional information regarding copyright ownership.

   * The ASF licenses this file to You under the Apache License, Version 2.0

   * (the "License"); you may not use this file except in compliance with

   * the License.  You may obtain a copy of the License at

   *

   *      http://www.apache.org/licenses/LICENSE-2.0

  *

  * Unless required by applicable law or agreed to in writing, software

  * distributed under the License is distributed on an "AS IS" BASIS,

  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

  * See the License for the specific language governing permissions and

  * limitations under the License.

  */

 package org.apache.wicket.ajax;

 import org.apache.wicket.Application;

 import org.apache.wicket.Component;

 import org.apache.wicket.Page;

 import org.apache.wicket.RequestContext;

 import org.apache.wicket.RequestCycle;

 import org.apache.wicket.ResourceReference;

 import org.apache.wicket.behavior.AbstractAjaxBehavior;

 import org.apache.wicket.markup.html.IHeaderResponse;

 import org.apache.wicket.markup.html.WicketEventReference;

 import org.apache.wicket.markup.html.resources.JavascriptResourceReference;

 import org.apache.wicket.protocol.http.WebApplication;

 import org.apache.wicket.settings.IDebugSettings;

 import org.apache.wicket.util.string.AppendingStringBuffer;

 import org.apache.wicket.util.string.Strings;

 import org.apache.wicket.util.time.Duration;

 public abstract class AbstractDefaultAjaxBehavior extends AbstractAjaxBehavior

 {

 	private static final long serialVersionUID = 1L;

	

 	public static final ResourceReference INDICATOR = new ResourceReference(

 		AbstractDefaultAjaxBehavior.class, "indicator.gif");

	

 	private static final ResourceReference JAVASCRIPT_DEBUG = new JavascriptResourceReference(

 		AbstractDefaultAjaxBehavior.class, "wicket-ajax-debug.js");

	

 	protected void onBind()

 	{

 		getComponent().setOutputMarkupId(true);

 	}

	

 	public void renderHead(IHeaderResponse response)

 	{

 		super.renderHead(response);

 		final IDebugSettings debugSettings = Application.get().getDebugSettings();

 		response.renderJavascriptReference(WicketEventReference.INSTANCE);

 		response.renderJavascriptReference(WicketAjaxReference.INSTANCE);

 		if (debugSettings.isAjaxDebugModeEnabled())

 		{

 			response.renderJavascriptReference(JAVASCRIPT_DEBUG);

 			response.renderJavascript("wicketAjaxDebugEnable=true;", "wicket-ajax-debug-enable");

 		}

 		RequestContext context = RequestContext.get();

 		if (context.isPortletRequest())

 		{

 			response.renderJavascript("Wicket.portlet=true", "wicket-ajax-portlet-flag");

 		}

 	}

	

 	protected IAjaxCallDecorator getAjaxCallDecorator()

 	{

 		return null;

 	}

	

	protected CharSequence getCallbackScript()

	{

		return getCallbackScript(false);

	}

	

	protected CharSequence getCallbackScript(boolean onlyTargetActivePage)

	{

		return generateCallbackScript("wicketAjaxGet('" + getCallbackUrl(onlyTargetActivePage) +

			"'");

	}

	

	protected CharSequence getPreconditionScript()

	{

		if (getComponent() instanceof Page)

		{

			return "return true;";

		}

		else

		{

			return "return Wicket.$('" + getComponent().getMarkupId() + "') != null;";

		}

	}

	

	protected CharSequence getFailureScript()

	{

		return null;

	}

	

	protected CharSequence getSuccessScript()

	{

		return null;

	}

	

	protected CharSequence generateCallbackScript(final CharSequence partialCall)

	{

		final CharSequence onSuccessScript = getSuccessScript();

		final CharSequence onFailureScript = getFailureScript();

		final CharSequence precondition = getPreconditionScript();

		final IAjaxCallDecorator decorator = getAjaxCallDecorator();

		String indicatorId = findIndicatorId();

		CharSequence success = (onSuccessScript == null) ? "" : onSuccessScript;

		CharSequence failure = (onFailureScript == null) ? "" : onFailureScript;

		if (decorator != null)

		{

			success = decorator.decorateOnSuccessScript(success);

		}

		if (!Strings.isEmpty(indicatorId))

		{

			String hide = ";wicketHide('" + indicatorId + "');";

			success = success + hide;

			failure = failure + hide;

		}

		if (decorator != null)

		{

			failure = decorator.decorateOnFailureScript(failure);

		}

		AppendingStringBuffer buff = new AppendingStringBuffer(256);

		buff.append("var ").append(IAjaxCallDecorator.WICKET_CALL_RESULT_VAR).append("=");

		buff.append(partialCall);

		if (success.length() == 0)

		{

			buff.append(",null");

		}

		else

		{

			buff.append(",function(){").append(success).append("}.bind(this)");

		}

		if (failure.length() == 0)

		{

			buff.append(",null");

		}

		else

		{

			buff.append(",function() { ").append(failure).append("}.bind(this)");

		}

		if (precondition != null)

		{

			buff.append(", function() {");

			buff.append(precondition);

			buff.append("}.bind(this)");

		}

		String channel = getChannelName();

		if (channel != null)

		{

			if (precondition == null)

			{

				buff.append(", null");

			}

			buff.append(", '");

			buff.append(channel);

			buff.append("'");

		}

		buff.append(");");

		CharSequence call = buff;

		if (!Strings.isEmpty(indicatorId))

		{

			call = new AppendingStringBuffer("wicketShow('").append(indicatorId)

				.append("');")

				.append(call);

		}

		if (decorator != null)

		{

			call = decorator.decorateScript(call);

		}

		return call;

	}

	protected String getChannelName()

	{

		return null;

	}

	

	protected String findIndicatorId()

	{

		if (getComponent() instanceof IAjaxIndicatorAware)

		{

			return ((IAjaxIndicatorAware)getComponent()).getAjaxIndicatorMarkupId();

		}

		if (this instanceof IAjaxIndicatorAware)

		{

			return ((IAjaxIndicatorAware)this).getAjaxIndicatorMarkupId();

		}

		Component parent = getComponent().getParent();

		while (parent != null)

		{

			if (parent instanceof IAjaxIndicatorAware)

			{

				return ((IAjaxIndicatorAware)parent).getAjaxIndicatorMarkupId();

			}

			parent = parent.getParent();

		}

		return null;

	}

	

	public final void onRequest()

	{

		WebApplication app = (WebApplication)getComponent().getApplication();

		AjaxRequestTarget target = app.newAjaxRequestTarget(getComponent().getPage());

		RequestCycle.get().setRequestTarget(target);

		respond(target);

	}

	

	// TODO rename this to onEvent or something? respond is mostly the same as

	// onRender

	// this is not the case this is still the event handling period. respond is

	// called

	// in the RequestCycle on the AjaxRequestTarget..

	protected abstract void respond(AjaxRequestTarget target);

	

	public static final CharSequence throttleScript(CharSequence script, String throttleId,

		Duration throttleDelay)

	{

		if (Strings.isEmpty(script))

		{

			throw new IllegalArgumentException("script cannot be empty");

		}

		if (Strings.isEmpty(throttleId))

		{

			throw new IllegalArgumentException("throttleId cannot be empty");

		}

		if (throttleDelay == null)

		{

			throw new IllegalArgumentException("throttleDelay cannot be null");

		}

		return new AppendingStringBuffer("wicketThrottler.throttle( '").append(throttleId)

			.append("', ")

			.append(throttleDelay.getMilliseconds())

			.append(", function() { ")

			.append(script)

			.append("});");

	}

}