/*
 * Copyright 2020-2099 sa-token.cc
 *
 * Licensed 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 cn.dev33.satoken.context.model;

import cn.dev33.satoken.error.SaErrorCode;
import cn.dev33.satoken.exception.SaTokenException;
import cn.dev33.satoken.router.SaHttpMethod;
import cn.dev33.satoken.util.SaFoxUtil;

import java.util.Collection;
import java.util.Map;

/**
 * Request 请求对象 包装类
 *
 * @author click33
 * @since 1.16.0
 */
public interface SaRequest {
	
	/**
	 * 获取底层被包装的源对象
	 * @return /
	 */
	Object getSource();
	
	/**
	 * 在 [ 请求体 ] 里获取一个参数值
	 * @param name 键 
	 * @return 值 
	 */
	String getParam(String name);

	/**
	 * 在 [ 请求体 ] 里获取一个参数值，值为空时返回默认值
	 * @param name 键 
	 * @param defaultValue 值为空时的默认值  
	 * @return 值 
	 */
	default String getParam(String name, String defaultValue) {
		String value = getParam(name);
		if(SaFoxUtil.isEmpty(value)) {
			return defaultValue;
		}
		return value;
	}

	/**
	 * 在 [ 请求体 ] 里检测提供的参数是否为指定值
	 * @param name 键 
	 * @param value 值 
	 * @return 是否相等 
	 */
	default boolean isParam(String name, String value) {
		 String paramValue = getParam(name);
		 return SaFoxUtil.isNotEmpty(paramValue) && paramValue.equals(value);
	}

	/**
	 * 在 [ 请求体 ] 里检测请求是否提供了指定参数
	 * @param name 参数名称 
	 * @return 是否提供 
	 */
	default boolean hasParam(String name) {
		 return SaFoxUtil.isNotEmpty(getParam(name));
	}
	
	/**
	 * 在 [ 请求体 ] 里获取一个值 （此值必须存在，否则抛出异常 ）
	 * @param name 键
	 * @return 参数值 
	 */
	default String getParamNotNull(String name) {
		String paramValue = getParam(name);
		if(SaFoxUtil.isEmpty(paramValue)) {
			throw new SaTokenException("缺少参数：" + name).setCode(SaErrorCode.CODE_12001);
		}
		return paramValue;
	}

	/**
	 * 获取 [ 请求体 ] 里提交的所有参数名称
	 * @return 参数名称列表
	 */
	Collection<String> getParamNames();

	/**
	 * 获取 [ 请求体 ] 里提交的所有参数
	 * @return 参数列表
	 */
	Map<String, String> getParamMap();

	/**
	 * 在 [ 请求头 ] 里获取一个值 
	 * @param name 键 
	 * @return 值 
	 */
	String getHeader(String name);

	/**
	 * 在 [ 请求头 ] 里获取一个值 
	 * @param name 键 
	 * @param defaultValue 值为空时的默认值  
	 * @return 值 
	 */
	default String getHeader(String name, String defaultValue) {
		String value = getHeader(name);
		if(SaFoxUtil.isEmpty(value)) {
			return defaultValue;
		}
		return value;
	}

	/**
	 * 在 [ Cookie作用域 ] 里获取一个值
	 * @param name 键 
	 * @return 值 
	 */
	String getCookieValue(String name);

	/**
	 * 在 [ Cookie作用域 ] 里获取一个值 (第一个此名称的)
	 * @param name 键
	 * @return 值
	 */
	String getCookieFirstValue(String name);

	/**
	 * 在 [ Cookie作用域 ] 里获取一个值 (最后一个此名称的)
	 * @param name 键
	 * @return 值
	 */
	String getCookieLastValue(String name);

	/**
	 * 返回当前请求path (不包括上下文名称) 
	 * @return /
	 */
	String getRequestPath();

	/**
	 * 返回当前请求 path 是否为指定值
	 * @param path path 
	 * @return /
	 */
	default boolean isPath(String path) {
		return getRequestPath().equals(path);
	}

	/**
	 * 返回当前请求的url，不带query参数，例：http://xxx.com/test
	 * @return /
	 */
	String getUrl();
	
	/**
	 * 返回当前请求的类型 
	 * @return /
	 */
	String getMethod();

	/**
	 * 返回当前请求 Method 是否为指定值
	 * @param method method
	 * @return /
	 */
	default boolean isMethod(String method) {
		return getMethod().equals(method);
	}

	/**
	 * 返回当前请求 Method 是否为指定值
	 * @param method method
	 * @return /
	 */
	default boolean isMethod(SaHttpMethod method) {
		return getMethod().equals(method.name());
	}

	/**
	 * 查询请求 host
	 * @return /
	 */
	String getHost();

	/**
	 * 判断此请求是否为 Ajax 异步请求
	 * @return /
	 */
	default boolean isAjax() {
		return getHeader("X-Requested-With") != null;
	}

	/**
	 * 转发请求 
	 * @param path 转发地址 
	 * @return 任意值 
	 */
	Object forward(String path);
	
}
