/*

   +----------------------------------------------------------------------+

   | Copyright © The PHP Group and Contributors.                          |

   +----------------------------------------------------------------------+

   | This source file is subject to the Modified BSD License that is      |

   | bundled with this package in the file LICENSE, and is available      |

   | through the World Wide Web at <https://www.php.net/license/>.        |

   |                                                                      |

   | SPDX-License-Identifier: BSD-3-Clause                                |

   +----------------------------------------------------------------------+

   | Author: Rasmus Lerdorf <rasmus@lerdorf.on.ca>                        |

   +----------------------------------------------------------------------+

 */

#include <stdio.h>

#include "php.h"

#include "ext/standard/php_standard.h"

#include "ext/date/php_date.h"

#include "SAPI.h"

#include "php_main.h"

#include "head.h"

#include <time.h>

#include "php_globals.h"

#include "zend_smart_str.h"

/* Implementation of the language Header() function */

/* {{{ Sends a raw HTTP header */

PHP_FUNCTION(header)

{

  bool rep = 1;

  sapi_header_line ctr = {0};

  char *line;

  size_t len;

  ZEND_PARSE_PARAMETERS_START(1, 3)

    Z_PARAM_STRING(line, len)

    Z_PARAM_OPTIONAL

    Z_PARAM_BOOL(rep)

    Z_PARAM_LONG(ctr.response_code)

  ZEND_PARSE_PARAMETERS_END();

  ctr.line = line;

  ctr.line_len = len;

  sapi_header_op(rep ? SAPI_HEADER_REPLACE:SAPI_HEADER_ADD, &ctr);

}

/* }}} */

/* {{{ Removes an HTTP header previously set using header() */

PHP_FUNCTION(header_remove)

{

  sapi_header_line ctr = {0};

  char *line = NULL;

  size_t len = 0;

  ZEND_PARSE_PARAMETERS_START(0, 1)

    Z_PARAM_OPTIONAL

    Z_PARAM_STRING_OR_NULL(line, len)

  ZEND_PARSE_PARAMETERS_END();

  ctr.line = line;

  ctr.line_len = len;

  sapi_header_op(line == NULL ? SAPI_HEADER_DELETE_ALL : SAPI_HEADER_DELETE, &ctr);

}

/* }}} */

PHPAPI bool php_header(void)

{

  if (sapi_send_headers()==FAILURE || SG(request_info).headers_only) {

    return false; /* don't allow output */

  } else {

    return true; /* allow output */

  }

}

PHPAPI bool php_is_valid_samesite_value(zend_string *value)

{

  return zend_string_equals_literal_ci(value, "Strict")

    || zend_string_equals_literal_ci(value, "Lax")

    || zend_string_equals_literal_ci(value, "None");

}

#define ILLEGAL_COOKIE_CHARACTER "\",\", \";\", \" \", \"\\t\", \"\\r\", \"\\n\", \"\\013\", or \"\\014\""

PHPAPI zend_result php_setcookie(zend_string *name, zend_string *value, time_t expires,

  zend_string *path, zend_string *domain, bool secure, bool httponly,

  zend_string *samesite, bool partitioned, bool url_encode)

{

  zend_string *dt;

  sapi_header_line ctr = {0};

  zend_result result;

  smart_str buf = {0};

  if (!ZSTR_LEN(name)) {

    zend_argument_must_not_be_empty_error(1);

    return FAILURE;

  }

  if (strpbrk(ZSTR_VAL(name), "=,; \t\r\n\013\014") != NULL) {   /* man isspace for \013 and \014 */

    zend_argument_value_error(1, "cannot contain \"=\", " ILLEGAL_COOKIE_CHARACTER);

    return FAILURE;

  }

  if (!url_encode && value &&

      strpbrk(ZSTR_VAL(value), ",; \t\r\n\013\014") != NULL) { /* man isspace for \013 and \014 */

    zend_argument_value_error(2, "cannot contain " ILLEGAL_COOKIE_CHARACTER);

    return FAILURE;

  }

  if (path && strpbrk(ZSTR_VAL(path), ",; \t\r\n\013\014") != NULL) { /* man isspace for \013 and \014 */

    zend_value_error("%s(): \"path\" option cannot contain " ILLEGAL_COOKIE_CHARACTER,

      get_active_function_name());

    return FAILURE;

  }

  if (domain && strpbrk(ZSTR_VAL(domain), ",; \t\r\n\013\014") != NULL) { /* man isspace for \013 and \014 */

    zend_value_error("%s(): \"domain\" option cannot contain " ILLEGAL_COOKIE_CHARACTER,

      get_active_function_name());

    return FAILURE;

  }

#ifdef ZEND_ENABLE_ZVAL_LONG64

  if (expires >= 253402300800) {

    zend_value_error("%s(): \"expires\" option cannot have a year greater than 9999",

      get_active_function_name());

    return FAILURE;

  }

#endif

  if (partitioned && !secure) {

    zend_value_error("%s(): \"partitioned\" option cannot be used without \"secure\" option",

      get_active_function_name());

    return FAILURE;

  }

  if (samesite && ZSTR_LEN(samesite) > 0 && !php_is_valid_samesite_value(samesite)) {

    zend_value_error("%s(): \"samesite\" option must be \"Strict\", \"Lax\", \"None\", or \"\"",

      get_active_function_name());

    return FAILURE;

  }

  if (value == NULL || ZSTR_LEN(value) == 0) {

    /*

     * MSIE doesn't delete a cookie when you set it to a null value

     * so in order to force cookies to be deleted, even on MSIE, we

     * pick an expiry date in the past

     */

    smart_str_appends(&buf, "Set-Cookie: ");

    smart_str_append(&buf, name);

    smart_str_appends(&buf, "=deleted; expires=Thu, 01 Jan 1970 00:00:01 GMT; Max-Age=0");

  } else {

    smart_str_appends(&buf, "Set-Cookie: ");

    smart_str_append(&buf, name);

    smart_str_appendc(&buf, '=');

    if (url_encode) {

      zend_string *encoded_value = php_raw_url_encode(ZSTR_VAL(value), ZSTR_LEN(value));

      smart_str_append(&buf, encoded_value);

      zend_string_release_ex(encoded_value, 0);

    } else {

      smart_str_append(&buf, value);

    }

    if (expires > 0) {

      double diff;

      smart_str_appends(&buf, COOKIE_EXPIRES);

      dt = php_format_date("D, d M Y H:i:s \\G\\M\\T", sizeof("D, d M Y H:i:s \\G\\M\\T")-1, expires, 0);

      smart_str_append(&buf, dt);

      zend_string_free(dt);

      diff = difftime(expires, php_time());

      if (diff < 0) {

        diff = 0;

      }

      smart_str_appends(&buf, COOKIE_MAX_AGE);

      smart_str_append_long(&buf, (zend_long) diff);

    }

  }

  if (path && ZSTR_LEN(path)) {

    smart_str_appends(&buf, COOKIE_PATH);

    smart_str_append(&buf, path);

  }

  if (domain && ZSTR_LEN(domain)) {

    smart_str_appends(&buf, COOKIE_DOMAIN);

    smart_str_append(&buf, domain);

  }

  if (secure) {

    smart_str_appends(&buf, COOKIE_SECURE);

  }

  if (httponly) {

    smart_str_appends(&buf, COOKIE_HTTPONLY);

  }

  if (samesite && ZSTR_LEN(samesite)) {

    smart_str_appends(&buf, COOKIE_SAMESITE);

    smart_str_append(&buf, samesite);

  }

  if (partitioned) {

    smart_str_appends(&buf, COOKIE_PARTITIONED);

  }

  ctr.line = ZSTR_VAL(buf.s);

  ctr.line_len = (uint32_t) ZSTR_LEN(buf.s);

  result = sapi_header_op(SAPI_HEADER_ADD, &ctr);

  zend_string_release(buf.s);

  return result;

}

static zend_result php_head_parse_cookie_options_array(HashTable *options, zend_long *expires, zend_string **path,

    zend_string **domain, bool *secure, bool *httponly, zend_string **samesite, bool *partitioned)

{

  zend_string *key;

  zval *value;

  ZEND_HASH_FOREACH_STR_KEY_VAL(options, key, value) {

    if (!key) {

      zend_value_error("%s(): option array cannot have numeric keys", get_active_function_name());

      return FAILURE;

    }

    if (zend_string_equals_literal_ci(key, "expires")) {

      *expires = zval_get_long(value);

    } else if (zend_string_equals_literal_ci(key, "path")) {

      if (*path) {

        zend_string_release(*path);

      }

      *path = zval_get_string(value);

    } else if (zend_string_equals_literal_ci(key, "domain")) {

      if (*domain) {

        zend_string_release(*domain);

      }

      *domain = zval_get_string(value);

    } else if (zend_string_equals_literal_ci(key, "secure")) {

      *secure = zend_is_true(value);

    } else if (zend_string_equals_literal_ci(key, "httponly")) {

      *httponly = zend_is_true(value);

    } else if (zend_string_equals_literal_ci(key, "samesite")) {

      if (*samesite) {

        zend_string_release(*samesite);

      }

      *samesite = zval_get_string(value);

    } else if (zend_string_equals_literal_ci(key, "partitioned")) {

      *partitioned = zend_is_true(value);

    } else {

      zend_value_error("%s(): option \"%s\" is invalid", get_active_function_name(), ZSTR_VAL(key));

      return FAILURE;

    }

  } ZEND_HASH_FOREACH_END();

  return SUCCESS;

}

static void php_setcookie_common(INTERNAL_FUNCTION_PARAMETERS, bool is_raw)

{

  HashTable *options = NULL;

  zend_long expires = 0;

  zend_string *name, *value = NULL, *path = NULL, *domain = NULL, *samesite = NULL;

  bool secure = 0, httponly = 0, partitioned = false;

  ZEND_PARSE_PARAMETERS_START(1, 7)

    Z_PARAM_STR(name)

    Z_PARAM_OPTIONAL

    Z_PARAM_STR(value)

    Z_PARAM_ARRAY_HT_OR_LONG(options, expires)

    Z_PARAM_STR(path)

    Z_PARAM_STR(domain)

    Z_PARAM_BOOL(secure)

    Z_PARAM_BOOL(httponly)

  ZEND_PARSE_PARAMETERS_END();

  if (options) {

    if (UNEXPECTED(ZEND_NUM_ARGS() > 3)) {

      zend_argument_count_error("%s(): Expects exactly 3 arguments when argument #3 "

        "($expires_or_options) is an array", get_active_function_name());

      RETURN_THROWS();

    }

    if (FAILURE == php_head_parse_cookie_options_array(options, &expires, &path,

      &domain, &secure, &httponly, &samesite, &partitioned)

    ) {

      goto cleanup;

    }

  }

  RETVAL_BOOL(php_setcookie(name, value, expires, path, domain, secure, httponly, samesite, partitioned, !is_raw) == SUCCESS);

  if (options) {

cleanup:

    if (path) {

      zend_string_release(path);

    }

    if (domain) {

      zend_string_release(domain);

    }

    if (samesite) {

      zend_string_release(samesite);

    }

  }

}

/* {{{ setcookie(string name [, string value [, array options]])

   Send a cookie */

PHP_FUNCTION(setcookie)

{

  php_setcookie_common(INTERNAL_FUNCTION_PARAM_PASSTHRU, false);

}

/* }}} */

/* {{{ setrawcookie(string name [, string value [, array options]])

   Send a cookie with no url encoding of the value */

PHP_FUNCTION(setrawcookie)

{

  php_setcookie_common(INTERNAL_FUNCTION_PARAM_PASSTHRU, true);

}

/* }}} */

/* {{{ Returns true if headers have already been sent, false otherwise */

PHP_FUNCTION(headers_sent)

{

  zval *by_ref_filename = NULL;

  zval *by_ref_line = NULL;

  const char *file = "";

  int line = 0;

  ZEND_PARSE_PARAMETERS_START(0, 2)

    Z_PARAM_OPTIONAL

    Z_PARAM_ZVAL(by_ref_filename)

    Z_PARAM_ZVAL(by_ref_line)

  ZEND_PARSE_PARAMETERS_END();

  if (SG(headers_sent)) {

    line = php_output_get_start_lineno();

    file = php_output_get_start_filename();

  }

  if (by_ref_filename) {

    if (file) {

      ZEND_TRY_ASSIGN_REF_STRING(by_ref_filename, file);

    } else {

      ZEND_TRY_ASSIGN_REF_EMPTY_STRING(by_ref_filename);

    }

  }

  if (by_ref_line) {

    ZEND_TRY_ASSIGN_REF_LONG(by_ref_line, line);

  }

  RETURN_BOOL(SG(headers_sent));

}

/* }}} */

/* {{{ php_head_apply_header_list_to_hash

   Turn an llist of sapi_header_struct headers into a numerically indexed zval hash */

static void php_head_apply_header_list_to_hash(void *data, void *arg)

{

  sapi_header_struct *sapi_header = (sapi_header_struct *)data;

  if (arg && sapi_header) {

    add_next_index_string((zval *)arg, (char *)(sapi_header->header));

  }

}

/* {{{ Return list of headers to be sent / already sent */

PHP_FUNCTION(headers_list)

{

  ZEND_PARSE_PARAMETERS_NONE();

  array_init(return_value);

  zend_llist_apply_with_argument(&SG(sapi_headers).headers, php_head_apply_header_list_to_hash, return_value);

}

/* }}} */

/* {{{ Sets a response code, or returns the current HTTP response code */

PHP_FUNCTION(http_response_code)

{

  zend_long response_code = 0;

  ZEND_PARSE_PARAMETERS_START(0, 1)

    Z_PARAM_OPTIONAL

    Z_PARAM_LONG(response_code)

  ZEND_PARSE_PARAMETERS_END();

  if (response_code)

  {

    if (SG(headers_sent) && !SG(request_info).no_headers) {

      const char *output_start_filename = php_output_get_start_filename();

      int output_start_lineno = php_output_get_start_lineno();

      if (output_start_filename) {

        php_error_docref(NULL, E_WARNING, "Cannot set response code - headers already sent "

          "(output started at %s:%d)", output_start_filename, output_start_lineno);

      } else {

        php_error_docref(NULL, E_WARNING, "Cannot set response code - headers already sent");

      }

      RETURN_FALSE;

    }

    if (SG(sapi_headers).http_status_line) {

      php_error_docref(NULL, E_WARNING, "Calling http_response_code() after header('HTTP/...') has no effect");

      // If it is decided that this should have effect in the future, replace warning with

      // efree(SG(sapi_headers).http_status_line);

      // SG(sapi_headers).http_status_line = NULL;

    }

    zend_long old_response_code;

    old_response_code = SG(sapi_headers).http_response_code;

    SG(sapi_headers).http_response_code = (int)response_code;

    if (old_response_code) {

      RETURN_LONG(old_response_code);

    }

    RETURN_TRUE;

  }

  if (!SG(sapi_headers).http_response_code) {

    RETURN_FALSE;

  }

  RETURN_LONG(SG(sapi_headers).http_response_code);

}

/* }}} */