/src/php-src/ext/uri/uri_parser_rfc3986.c

Source
/*
   +----------------------------------------------------------------------+
   | 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                                |
   +----------------------------------------------------------------------+
   | Authors: Máté Kocsis <kocsismate@php.net>                            |
   +----------------------------------------------------------------------+
*/

#include "php.h"
#include "uri_parser_rfc3986.h"
#include "php_uri_common.h"
#include "Zend/zend_enum.h"
#include "Zend/zend_smart_str.h"
#include "Zend/zend_exceptions.h"

#include <uriparser/Uri.h>

struct php_uri_parser_rfc3986_uris {
  UriUriA uri;
  UriUriA normalized_uri;
  unsigned int normalization_mask;
  bool normalized_uri_initialized;
};

static void *php_uri_parser_rfc3986_memory_manager_malloc(UriMemoryManager *memory_manager, size_t size)
{
  return femalloc(size, /* fallible */ true);
}

static void *php_uri_parser_rfc3986_memory_manager_calloc(UriMemoryManager *memory_manager, size_t nmemb, size_t size)
{
  return fecalloc(nmemb, size, /* fallible */ true);
}

static void *php_uri_parser_rfc3986_memory_manager_realloc(UriMemoryManager *memory_manager, void *ptr, size_t size)
{
  return safe_ferealloc(ptr, 1, size, 0, /* fallible */ true);
}

static void *php_uri_parser_rfc3986_memory_manager_reallocarray(UriMemoryManager *memory_manager, void *ptr, size_t nmemb, size_t size)
{
  return safe_ferealloc(ptr, nmemb, size, 0, /* fallible */ true);
}

static void php_uri_parser_rfc3986_memory_manager_destroy(UriMemoryManager *memory_manager, void *ptr)
{
  efree(ptr);
}

static const UriMemoryManager php_uri_parser_rfc3986_memory_manager = {
  .malloc = php_uri_parser_rfc3986_memory_manager_malloc,
  .calloc = php_uri_parser_rfc3986_memory_manager_calloc,
  .realloc = php_uri_parser_rfc3986_memory_manager_realloc,
  .reallocarray = php_uri_parser_rfc3986_memory_manager_reallocarray,
  .free = php_uri_parser_rfc3986_memory_manager_destroy,
  .userData = NULL,
};

/* The library expects a pointer to a non-const UriMemoryManager, but does
 * not actually modify it (and neither does our implementation). Use a
 * const struct with a non-const pointer for convenience. */
static UriMemoryManager* const mm = (UriMemoryManager*)&php_uri_parser_rfc3986_memory_manager;

static bool handle_pending_oom(void)
{
  if (ZEND_HAS_OOM()) {
    zend_handle_delayed_oom();
    return true;
  }

  return false;
}

static inline size_t get_text_range_length(const UriTextRangeA *range)
{
  return range->afterLast - range->first;
}

static inline bool has_text_range(const UriTextRangeA *range)
{
  return range->first != NULL && range->afterLast != NULL;
}

/* Returns false when the copy could not be allocated. */
ZEND_ATTRIBUTE_NONNULL static bool copy_uri(UriUriA *new_uriparser_uri, const UriUriA *uriparser_uri)
{
  int result = uriCopyUriMmA(new_uriparser_uri, uriparser_uri, mm);
  ZEND_ASSERT(result == URI_SUCCESS || result == URI_ERROR_MALLOC);

  return result == URI_SUCCESS;
}

/* Returns NULL when the normalized form could not be allocated. */
ZEND_ATTRIBUTE_NONNULL static UriUriA *get_normalized_uri(php_uri_parser_rfc3986_uris *uriparser_uris) {
  if (!uriparser_uris->normalized_uri_initialized) {
    int mask_result = uriNormalizeSyntaxMaskRequiredExA(&uriparser_uris->uri, &uriparser_uris->normalization_mask);
    ZEND_ASSERT(mask_result == URI_SUCCESS);

    if (uriparser_uris->normalization_mask != URI_NORMALIZED) {
      if (UNEXPECTED(!copy_uri(&uriparser_uris->normalized_uri, &uriparser_uris->uri))) {
        return NULL;
      }
      int result = uriNormalizeSyntaxExMmA(&uriparser_uris->normalized_uri, uriparser_uris->normalization_mask, mm);
      ZEND_ASSERT(result == URI_SUCCESS || result == URI_ERROR_MALLOC);
      if (UNEXPECTED(result != URI_SUCCESS)) {
        uriFreeUriMembersMmA(&uriparser_uris->normalized_uri, mm);
        memset(&uriparser_uris->normalized_uri, 0, sizeof(uriparser_uris->normalized_uri));
        return NULL;
      }
    }
    uriparser_uris->normalized_uri_initialized = true;
  }

  if (uriparser_uris->normalization_mask == URI_NORMALIZED) {
    return &uriparser_uris->uri;
  }

  return &uriparser_uris->normalized_uri;
}

ZEND_ATTRIBUTE_NONNULL static UriUriA *get_uri_for_reading(php_uri_parser_rfc3986_uris *uriparser_uris, const php_uri_component_read_mode read_mode)
{
  switch (read_mode) {
    case PHP_URI_COMPONENT_READ_MODE_RAW:
      return &uriparser_uris->uri;
    case PHP_URI_COMPONENT_READ_MODE_NORMALIZED_ASCII:
      ZEND_FALLTHROUGH;
    case PHP_URI_COMPONENT_READ_MODE_NORMALIZED_UNICODE:
      return get_normalized_uri(uriparser_uris);
    default: ZEND_UNREACHABLE();
  }
}

ZEND_ATTRIBUTE_NONNULL static UriUriA *get_uri_for_writing(php_uri_parser_rfc3986_uris *uriparser_uris)
{
  return &uriparser_uris->uri;
}

ZEND_ATTRIBUTE_NONNULL void php_uri_parser_rfc3986_uri_type_read(php_uri_parser_rfc3986_uris *uri, zval *retval)
{
  const UriUriA *uriparser_uri = get_uri_for_reading(uri, PHP_URI_COMPONENT_READ_MODE_RAW);

  zend_object *value;

  if (has_text_range(&uriparser_uri->scheme)) {
    value = zend_enum_get_case_by_id(php_uri_ce_rfc3986_uri_type, ZEND_ENUM_Uri_Rfc3986_UriType_Uri);
  } else if (has_text_range(&uriparser_uri->hostText)) {
    value = zend_enum_get_case_by_id(php_uri_ce_rfc3986_uri_type, ZEND_ENUM_Uri_Rfc3986_UriType_NetworkPathReference);
  } else if (uriparser_uri->absolutePath) {
    value = zend_enum_get_case_by_id(php_uri_ce_rfc3986_uri_type, ZEND_ENUM_Uri_Rfc3986_UriType_AbsolutePathReference);
  } else {
    value = zend_enum_get_case_by_id(php_uri_ce_rfc3986_uri_type, ZEND_ENUM_Uri_Rfc3986_UriType_RelativePathReference);
  }

  ZVAL_OBJ_COPY(retval, value);
}

ZEND_ATTRIBUTE_NONNULL static zend_result php_uri_parser_rfc3986_scheme_read(void *uri, const php_uri_component_read_mode read_mode, zval *retval)
{
  const UriUriA *uriparser_uri = get_uri_for_reading(uri, read_mode);
  if (UNEXPECTED(uriparser_uri == NULL)) {
    return FAILURE;
  }

  if (has_text_range(&uriparser_uri->scheme)) {
    ZVAL_STRINGL(retval, uriparser_uri->scheme.first, get_text_range_length(&uriparser_uri->scheme));
  } else {
    ZVAL_NULL(retval);
  }

  return SUCCESS;
}

static zend_result php_uri_parser_rfc3986_scheme_write(void *uri, const zval *value, zval *errors)
{
  UriUriA *uriparser_uri = get_uri_for_writing(uri);
  int result;

  if (Z_TYPE_P(value) == IS_NULL) {
    result = uriSetSchemeMmA(uriparser_uri, NULL, NULL, mm);
  } else {
    result = uriSetSchemeMmA(uriparser_uri, Z_STRVAL_P(value), Z_STRVAL_P(value) + Z_STRLEN_P(value), mm);
  }

  switch (result) {
    case URI_SUCCESS:
      return SUCCESS;
    case URI_ERROR_SYNTAX:
      zend_throw_exception(php_uri_ce_invalid_uri_exception, "The specified scheme is malformed", 0);
      return FAILURE;
    default:
      if (handle_pending_oom()) {
        return FAILURE;
      }

      /* This should be unreachable in practice. */
      zend_throw_exception(php_uri_ce_error, "Failed to update the scheme", 0);
      return FAILURE;
  }
}

ZEND_ATTRIBUTE_NONNULL zend_result php_uri_parser_rfc3986_userinfo_read(php_uri_parser_rfc3986_uris *uri, const php_uri_component_read_mode read_mode, zval *retval)
{
  const UriUriA *uriparser_uri = get_uri_for_reading(uri, read_mode);
  if (UNEXPECTED(uriparser_uri == NULL)) {
    return FAILURE;
  }

  if (has_text_range(&uriparser_uri->userInfo)) {
    ZVAL_STRINGL(retval, uriparser_uri->userInfo.first, get_text_range_length(&uriparser_uri->userInfo));
  } else {
    ZVAL_NULL(retval);
  }

  return SUCCESS;
}

zend_result php_uri_parser_rfc3986_userinfo_write(php_uri_parser_rfc3986_uris *uri, const zval *value, zval *errors)
{
  UriUriA *uriparser_uri = get_uri_for_writing(uri);
  int result;

  if (Z_TYPE_P(value) == IS_NULL) {
    result = uriSetUserInfoMmA(uriparser_uri, NULL, NULL, mm);
  } else {
    result = uriSetUserInfoMmA(uriparser_uri, Z_STRVAL_P(value), Z_STRVAL_P(value) + Z_STRLEN_P(value), mm);
  }

  switch (result) {
    case URI_SUCCESS:
      return SUCCESS;
    case URI_ERROR_SETUSERINFO_HOST_NOT_SET:
      zend_throw_exception(php_uri_ce_invalid_uri_exception, "Cannot set a userinfo without having a host", 0);
      return FAILURE;
    case URI_ERROR_SYNTAX:
      zend_throw_exception(php_uri_ce_invalid_uri_exception, "The specified userinfo is malformed", 0);
      return FAILURE;
    default:
      if (handle_pending_oom()) {
        return FAILURE;
      }

      /* This should be unreachable in practice. */
      zend_throw_exception(php_uri_ce_error, "Failed to update the userinfo", 0);
      return FAILURE;
  }
}

ZEND_ATTRIBUTE_NONNULL static zend_result php_uri_parser_rfc3986_username_read(void *uri, const php_uri_component_read_mode read_mode, zval *retval)
{
  const UriUriA *uriparser_uri = get_uri_for_reading(uri, read_mode);
  if (UNEXPECTED(uriparser_uri == NULL)) {
    return FAILURE;
  }

  if (has_text_range(&uriparser_uri->userInfo)) {
    size_t length = get_text_range_length(&uriparser_uri->userInfo);
    const char *c = memchr(uriparser_uri->userInfo.first, ':', length);

    if (c == NULL && length > 0) {
      ZVAL_STRINGL(retval, uriparser_uri->userInfo.first, length);
    } else if (c != NULL && c - uriparser_uri->userInfo.first > 0) {
      ZVAL_STRINGL(retval, uriparser_uri->userInfo.first, c - uriparser_uri->userInfo.first);
    } else {
      ZVAL_EMPTY_STRING(retval);
    }
  } else {
    ZVAL_NULL(retval);
  }

  return SUCCESS;
}

ZEND_ATTRIBUTE_NONNULL static zend_result php_uri_parser_rfc3986_password_read(void *uri, const php_uri_component_read_mode read_mode, zval *retval)
{
  const UriUriA *uriparser_uri = get_uri_for_reading(uri, read_mode);
  if (UNEXPECTED(uriparser_uri == NULL)) {
    return FAILURE;
  }

  if (has_text_range(&uriparser_uri->userInfo)) {
    const char *c = memchr(uriparser_uri->userInfo.first, ':', get_text_range_length(&uriparser_uri->userInfo));

    if (c != NULL && uriparser_uri->userInfo.afterLast - c - 1 > 0) {
      ZVAL_STRINGL(retval, c + 1, uriparser_uri->userInfo.afterLast - c - 1);
    } else {
      ZVAL_EMPTY_STRING(retval);
    }
  } else {
    ZVAL_NULL(retval);
  }

  return SUCCESS;
}

ZEND_ATTRIBUTE_NONNULL static zend_result php_uri_parser_rfc3986_host_read(void *uri, const php_uri_component_read_mode read_mode, zval *retval)
{
  const UriUriA *uriparser_uri = get_uri_for_reading(uri, read_mode);
  if (UNEXPECTED(uriparser_uri == NULL)) {
    return FAILURE;
  }

  if (has_text_range(&uriparser_uri->hostText)) {
    if (uriparser_uri->hostData.ip6 != NULL || uriparser_uri->hostData.ipFuture.first != NULL) {
      /* the textual representation of the host is always accessible in the .hostText field no matter what the host is */
      zend_string *host_str = zend_string_concat3(
        "[", 1,
        uriparser_uri->hostText.first, get_text_range_length(&uriparser_uri->hostText),
        "]", 1
      );
      ZVAL_NEW_STR(retval, host_str);
    } else {
      ZVAL_STRINGL(retval, uriparser_uri->hostText.first, get_text_range_length(&uriparser_uri->hostText));
    }
  } else {
    ZVAL_NULL(retval);
  }

  return SUCCESS;
}

ZEND_ATTRIBUTE_NONNULL void php_uri_parser_rfc3986_host_type_read(php_uri_parser_rfc3986_uris *uri, zval *retval)
{
  const UriUriA *uriparser_uri = get_uri_for_reading(uri, PHP_URI_COMPONENT_READ_MODE_RAW);

  if (!has_text_range(&uriparser_uri->hostText)) {
    ZVAL_NULL(retval);
    return;
  }

  zend_object *value;

  if (uriparser_uri->hostData.ip4 != NULL) {
    value = zend_enum_get_case_by_id(php_uri_ce_rfc3986_uri_host_type, ZEND_ENUM_Uri_Rfc3986_UriHostType_IpV4);
  } else if (uriparser_uri->hostData.ip6 != NULL) {
    value = zend_enum_get_case_by_id(php_uri_ce_rfc3986_uri_host_type, ZEND_ENUM_Uri_Rfc3986_UriHostType_IpV6);
  } else if (has_text_range(&uriparser_uri->hostData.ipFuture)) {
    value = zend_enum_get_case_by_id(php_uri_ce_rfc3986_uri_host_type, ZEND_ENUM_Uri_Rfc3986_UriHostType_IpVFuture);
  } else {
    value = zend_enum_get_case_by_id(php_uri_ce_rfc3986_uri_host_type, ZEND_ENUM_Uri_Rfc3986_UriHostType_RegisteredName);
  }

  ZVAL_OBJ_COPY(retval, value);
}

static zend_result php_uri_parser_rfc3986_host_write(void *uri, const zval *value, zval *errors)
{
  UriUriA *uriparser_uri = get_uri_for_writing(uri);
  int result;

  if (Z_TYPE_P(value) == IS_NULL) {
    result = uriSetHostAutoMmA(uriparser_uri, NULL, NULL, mm);
  } else {
    result = uriSetHostAutoMmA(uriparser_uri, Z_STRVAL_P(value), Z_STRVAL_P(value) + Z_STRLEN_P(value), mm);
  }

  switch (result) {
    case URI_SUCCESS:
      return SUCCESS;
    case URI_ERROR_SETHOST_PORT_SET:
      zend_throw_exception(php_uri_ce_invalid_uri_exception, "Cannot remove the host from a URI that has a port", 0);
      return FAILURE;
    case URI_ERROR_SETHOST_USERINFO_SET:
      zend_throw_exception(php_uri_ce_invalid_uri_exception, "Cannot remove the host from a URI that has a userinfo", 0);
      return FAILURE;
    case URI_ERROR_SYNTAX:
      zend_throw_exception(php_uri_ce_invalid_uri_exception, "The specified host is malformed", 0);
      return FAILURE;
    default:
      if (handle_pending_oom()) {
        return FAILURE;
      }

      /* This should be unreachable in practice. */
      zend_throw_exception(php_uri_ce_error, "Failed to update the host", 0);
      return FAILURE;
  }
}

ZEND_ATTRIBUTE_NONNULL static zend_long port_str_to_zend_long_checked(const char *str, const size_t len)
{
  if (len > MAX_LENGTH_OF_LONG) {
    return -1;
  }

  char buf[MAX_LENGTH_OF_LONG + 1];
  *(char*)zend_mempcpy(buf, str, len) = 0;

  zend_ulong result = ZEND_STRTOUL(buf, NULL, 10);

  if (result > ZEND_LONG_MAX) {
    return -1;
  }

  return (zend_long)result;
}

ZEND_ATTRIBUTE_NONNULL static zend_result php_uri_parser_rfc3986_port_read(void *uri, const php_uri_component_read_mode read_mode, zval *retval)
{
  const UriUriA *uriparser_uri = get_uri_for_reading(uri, read_mode);
  if (UNEXPECTED(uriparser_uri == NULL)) {
    return FAILURE;
  }

  if (has_text_range(&uriparser_uri->portText) && get_text_range_length(&uriparser_uri->portText) > 0) {
    ZVAL_LONG(retval, port_str_to_zend_long_checked(uriparser_uri->portText.first, get_text_range_length(&uriparser_uri->portText)));
  } else {
    ZVAL_NULL(retval);
  }

  return SUCCESS;
}

static zend_result php_uri_parser_rfc3986_port_write(void *uri, const zval *value, zval *errors)
{
  UriUriA *uriparser_uri = get_uri_for_writing(uri);
  int result;

  if (Z_TYPE_P(value) == IS_NULL) {
    result = uriSetPortTextMmA(uriparser_uri, NULL, NULL, mm);
  } else {
    zend_string *tmp = zend_long_to_str(Z_LVAL_P(value));
    result = uriSetPortTextMmA(uriparser_uri, ZSTR_VAL(tmp), ZSTR_VAL(tmp) + ZSTR_LEN(tmp), mm);
    zend_string_release_ex(tmp, false);
  }

  switch (result) {
    case URI_SUCCESS:
      return SUCCESS;
    case URI_ERROR_SETPORT_HOST_NOT_SET:
      zend_throw_exception(php_uri_ce_invalid_uri_exception, "Cannot set a port without having a host", 0);
      return FAILURE;
    case URI_ERROR_SYNTAX:
      zend_throw_exception(php_uri_ce_invalid_uri_exception, "The specified port is malformed", 0);
      return FAILURE;
    default:
      if (handle_pending_oom()) {
        return FAILURE;
      }

      /* This should be unreachable in practice. */
      zend_throw_exception(php_uri_ce_error, "Failed to update the port", 0);
      return FAILURE;
  }
}

ZEND_ATTRIBUTE_NONNULL static zend_result php_uri_parser_rfc3986_path_read(void *uri, const php_uri_component_read_mode read_mode, zval *retval)
{
  const UriUriA *uriparser_uri = get_uri_for_reading(uri, read_mode);
  if (UNEXPECTED(uriparser_uri == NULL)) {
    return FAILURE;
  }

  if (uriparser_uri->pathHead != NULL) {
    size_t total_len = 0;
    const bool need_leading_slash = uriparser_uri->absolutePath || uriHasHostA(uriparser_uri);

    if (need_leading_slash) {
      total_len++;
    }

    for (const UriPathSegmentA *p = uriparser_uri->pathHead; p; p = p->next) {
      total_len += get_text_range_length(&p->text);
      if (p->next) {
        total_len++;
      }
    }

    zend_string *str = zend_string_alloc(total_len, false);
    char *out = ZSTR_VAL(str);

    if (need_leading_slash) {
      *(out++) = '/';
    }

    for (const UriPathSegmentA *p = uriparser_uri->pathHead; p; p = p->next) {
      out = zend_mempcpy(out, p->text.first, get_text_range_length(&p->text));
      if (p->next) {
        *(out++) = '/';
      }
    }

    *out = '\0';
    ZVAL_NEW_STR(retval, str);
  } else if (uriparser_uri->absolutePath) {
    ZVAL_CHAR(retval, '/');
  } else {
    ZVAL_EMPTY_STRING(retval);
  }

  return SUCCESS;
}

static zend_result php_uri_parser_rfc3986_path_write(void *uri, const zval *value, zval *errors)
{
  UriUriA *uriparser_uri = get_uri_for_writing(uri);
  int result;

  if (Z_STRLEN_P(value) == 0) {
    result = uriSetPathMmA(uriparser_uri, NULL, NULL, mm);
  } else {
    result = uriSetPathMmA(uriparser_uri, Z_STRVAL_P(value), Z_STRVAL_P(value) + Z_STRLEN_P(value), mm);
  }

  switch (result) {
    case URI_SUCCESS:
      return SUCCESS;
    case URI_ERROR_SYNTAX:
      zend_throw_exception(php_uri_ce_invalid_uri_exception, "The specified path is malformed", 0);
      return FAILURE;
    default:
      if (handle_pending_oom()) {
        return FAILURE;
      }

      /* This should be unreachable in practice. */
      zend_throw_exception(php_uri_ce_error, "Failed to update the path", 0);
      return FAILURE;
  }
}

ZEND_ATTRIBUTE_NONNULL static zend_result php_uri_parser_rfc3986_query_read(void *uri, const php_uri_component_read_mode read_mode, zval *retval)
{
  const UriUriA *uriparser_uri = get_uri_for_reading(uri, read_mode);
  if (UNEXPECTED(uriparser_uri == NULL)) {
    return FAILURE;
  }

  if (has_text_range(&uriparser_uri->query)) {
    ZVAL_STRINGL(retval, uriparser_uri->query.first, get_text_range_length(&uriparser_uri->query));
  } else {
    ZVAL_NULL(retval);
  }

  return SUCCESS;
}

static zend_result php_uri_parser_rfc3986_query_write(void *uri, const zval *value, zval *errors)
{
  UriUriA *uriparser_uri = get_uri_for_writing(uri);
  int result;

  if (Z_TYPE_P(value) == IS_NULL) {
    result = uriSetQueryMmA(uriparser_uri, NULL, NULL, mm);
  } else {
    result = uriSetQueryMmA(uriparser_uri, Z_STRVAL_P(value), Z_STRVAL_P(value) + Z_STRLEN_P(value), mm);
  }

  switch (result) {
    case URI_SUCCESS:
      return SUCCESS;
    case URI_ERROR_SYNTAX:
      zend_throw_exception(php_uri_ce_invalid_uri_exception, "The specified query is malformed", 0);
      return FAILURE;
    default:
      if (handle_pending_oom()) {
        return FAILURE;
      }

      /* This should be unreachable in practice. */
      zend_throw_exception(php_uri_ce_error, "Failed to update the query", 0);
      return FAILURE;
  }
}

ZEND_ATTRIBUTE_NONNULL static zend_result php_uri_parser_rfc3986_fragment_read(void *uri, const php_uri_component_read_mode read_mode, zval *retval)
{
  const UriUriA *uriparser_uri = get_uri_for_reading(uri, read_mode);
  if (UNEXPECTED(uriparser_uri == NULL)) {
    return FAILURE;
  }

  if (has_text_range(&uriparser_uri->fragment)) {
    ZVAL_STRINGL(retval, uriparser_uri->fragment.first, get_text_range_length(&uriparser_uri->fragment));
  } else {
    ZVAL_NULL(retval);
  }

  return SUCCESS;
}

static zend_result php_uri_parser_rfc3986_fragment_write(void *uri, const zval *value, zval *errors)
{
  UriUriA *uriparser_uri = get_uri_for_writing(uri);
  int result;

  if (Z_TYPE_P(value) == IS_NULL) {
    result = uriSetFragmentMmA(uriparser_uri, NULL, NULL, mm);
  } else {
    result = uriSetFragmentMmA(uriparser_uri, Z_STRVAL_P(value), Z_STRVAL_P(value) + Z_STRLEN_P(value), mm);
  }

  switch (result) {
    case URI_SUCCESS:
      return SUCCESS;
    case URI_ERROR_SYNTAX:
      zend_throw_exception(php_uri_ce_invalid_uri_exception, "The specified fragment is malformed", 0);
      return FAILURE;
    default:
      if (handle_pending_oom()) {
        return FAILURE;
      }

      /* This should be unreachable in practice. */
      zend_throw_exception(php_uri_ce_error, "Failed to update the fragment", 0);
      return FAILURE;
  }
}

static php_uri_parser_rfc3986_uris *uriparser_create_uris(void)
{
  php_uri_parser_rfc3986_uris *uriparser_uris = ecalloc(1, sizeof(*uriparser_uris));
  uriparser_uris->normalized_uri_initialized = false;

  return uriparser_uris;
}

static zend_result php_uri_parser_rfc3986_add_base_url(
  UriUriA *tmp, const UriUriA *uri, const php_uri_parser_rfc3986_uris *uriparser_base_urls, const bool silent
) {
  const int result = uriAddBaseUriExMmA(tmp, uri, &uriparser_base_urls->uri, URI_RESOLVE_STRICTLY, mm);
  if (result != URI_SUCCESS) {
    if (!handle_pending_oom() && !silent) {
      switch (result) {
        case URI_ERROR_ADDBASE_REL_BASE:
          zend_throw_exception(php_uri_ce_invalid_uri_exception, "The specified base URI must be absolute", 0);
          break;
        default:
          /* This should be unreachable in practice. */
          zend_throw_exception(php_uri_ce_error, "Failed to resolve the specified URI against the base URI", 0);
          break;
      }
    }

    return FAILURE;
  }

  return SUCCESS;
}

php_uri_parser_rfc3986_uris *php_uri_parser_rfc3986_parse_ex(const char *uri_str, const size_t uri_str_len, const php_uri_parser_rfc3986_uris *uriparser_base_urls, const bool silent)
{
  UriUriA uri = {0};

  /* Parse the URI. */
  const int result = uriParseSingleUriExMmA(&uri, uri_str, uri_str + uri_str_len, NULL, mm);
  if (result != URI_SUCCESS) {
    if (!handle_pending_oom() && !silent) {
      switch (result) {
        case URI_ERROR_SYNTAX:
          zend_throw_exception(php_uri_ce_invalid_uri_exception, "The specified URI is malformed", 0);
          break;
        default:
          /* This should be unreachable in practice. */
          zend_throw_exception(php_uri_ce_error, "Failed to parse the specified URI", 0);
          break;
      }
    }

    goto fail;
  }

  if (uriparser_base_urls != NULL) {
    UriUriA tmp = {0};

    /* Combine the parsed URI with the base URI and store the result in 'tmp',
     * since the target and source URLs must be distinct. */
    if (php_uri_parser_rfc3986_add_base_url(&tmp, &uri, uriparser_base_urls, silent) == FAILURE) {
      goto fail;
    }

    /* Store the combined URI back into 'uri'. */
    uriFreeUriMembersMmA(&uri, mm);
    uri = tmp;
  }

  /* Make the resulting URI independent of the 'uri_str'. */
  if (UNEXPECTED(uriMakeOwnerMmA(&uri, mm) != URI_SUCCESS)) {
    /* The only documented failure is a failed allocation, and the caller
     * expects either a URI or a reported error. */
    if (!handle_pending_oom() && !silent) {
      zend_throw_exception(php_uri_ce_error, "Failed to parse the specified URI", 0);
    }

    goto fail;
  }

  if (has_text_range(&uri.portText) && get_text_range_length(&uri.portText) > 0) {
    if (port_str_to_zend_long_checked(uri.portText.first, get_text_range_length(&uri.portText)) == -1) {
      if (!silent) {
        zend_throw_exception(php_uri_ce_invalid_uri_exception, "The port is out of range", 0);
      }

      goto fail;
    }
  }

  php_uri_parser_rfc3986_uris *uriparser_uris = uriparser_create_uris();
  uriparser_uris->uri = uri;

  return uriparser_uris;

 fail:

  uriFreeUriMembersMmA(&uri, mm);

  return NULL;
}

static void *php_uri_parser_rfc3986_parse(const char *uri_str, const size_t uri_str_len, const void *base_url, zval *errors, bool silent)
{
  return php_uri_parser_rfc3986_parse_ex(uri_str, uri_str_len, base_url, silent);
}

ZEND_ATTRIBUTE_NONNULL static void *php_uri_parser_rfc3986_clone(void *uri)
{
  const php_uri_parser_rfc3986_uris *uriparser_uris = uri;

  php_uri_parser_rfc3986_uris *new_uriparser_uris = uriparser_create_uris();
  if (UNEXPECTED(!copy_uri(&new_uriparser_uris->uri, &uriparser_uris->uri))) {
    efree(new_uriparser_uris);
    return NULL;
  }
  /* Do not copy the normalized URI: The expected action after cloning is
   * modifying the cloned URI (which will invalidate the cached normalized
   * URI). */

  return new_uriparser_uris;
}

ZEND_ATTRIBUTE_NONNULL static zend_string *php_uri_parser_rfc3986_to_string(void *uri, const php_uri_recomposition_mode recomposition_mode, const bool exclude_fragment)
{
  php_uri_parser_rfc3986_uris *uriparser_uris = uri;
  const UriUriA *uriparser_uri;

  if (recomposition_mode == PHP_URI_RECOMPOSITION_MODE_RAW_ASCII || recomposition_mode == PHP_URI_RECOMPOSITION_MODE_RAW_UNICODE) {
    uriparser_uri = &uriparser_uris->uri;
  } else {
    uriparser_uri = get_normalized_uri(uriparser_uris);
    if (UNEXPECTED(uriparser_uri == NULL)) {
      return NULL;
    }
  }

  int charsRequired = 0;
  int result = uriToStringCharsRequiredA(uriparser_uri, &charsRequired);
  ZEND_ASSERT(result == URI_SUCCESS);

  charsRequired++;

  zend_string *uri_string = zend_string_alloc(charsRequired - 1, false);
  result = uriToStringA(ZSTR_VAL(uri_string), uriparser_uri, charsRequired, NULL);
  ZEND_ASSERT(result == URI_SUCCESS);

  if (exclude_fragment) {
    const char *pos = zend_memrchr(ZSTR_VAL(uri_string), '#', ZSTR_LEN(uri_string));
    if (pos != NULL) {
      uri_string = zend_string_truncate(uri_string, (pos - ZSTR_VAL(uri_string)), false);
      ZSTR_VAL(uri_string)[ZSTR_LEN(uri_string)] = '\0';
    }
  }

  return uri_string;
}

static void php_uri_parser_rfc3986_destroy(void *uri)
{
  php_uri_parser_rfc3986_uris *uriparser_uris = uri;

  if (UNEXPECTED(uriparser_uris == NULL)) {
    return;
  }

  uriFreeUriMembersMmA(&uriparser_uris->uri, mm);
  uriFreeUriMembersMmA(&uriparser_uris->normalized_uri, mm);

  efree(uriparser_uris);
}

static zend_always_inline zend_result php_uri_parser_rfc3986_validate_component_result(const bool well_formed, const char *component_name)
{
  if (well_formed) {
    return SUCCESS;
  }

  zend_throw_exception_ex(php_uri_ce_invalid_uri_exception, 0, "The specified %s is malformed", component_name);
  return FAILURE;
}

ZEND_ATTRIBUTE_NONNULL zend_result php_uri_parser_rfc3986_scheme_validate(const zend_string *scheme)
{
  const char *p = ZSTR_VAL(scheme);
  const size_t len = ZSTR_LEN(scheme);
  const bool well_formed = uriIsWellFormedSchemeA(p, p + len) == URI_TRUE;

  return php_uri_parser_rfc3986_validate_component_result(well_formed, "scheme");
}

ZEND_ATTRIBUTE_NONNULL zend_result php_uri_parser_rfc3986_userinfo_validate(const zend_string *userinfo)
{
  const char *p = ZSTR_VAL(userinfo);
  const size_t len = ZSTR_LEN(userinfo);
  const bool well_formed = uriIsWellFormedUserInfoA(p, p + len) == URI_TRUE;

  return php_uri_parser_rfc3986_validate_component_result(well_formed, "userinfo");
}

ZEND_ATTRIBUTE_NONNULL zend_result php_uri_parser_rfc3986_host_validate(const zend_string *host)
{
  const char *p = ZSTR_VAL(host);
  const size_t len = ZSTR_LEN(host);

  if (len == 0) {
    return SUCCESS;
  }

  if (p[0] == '[') {
    if (p[len - 1] != ']') {
      return php_uri_parser_rfc3986_validate_component_result(false, "host");
    }

    if (len >= 2 && (p[1] == 'v' || p[1] == 'V')) {
      return php_uri_parser_rfc3986_validate_component_result(
        uriIsWellFormedHostIpFutureMmA(p + 1, p + len - 1, mm) == URI_SUCCESS,
        "host"
      );
    }

    return php_uri_parser_rfc3986_validate_component_result(
      uriIsWellFormedHostIp6MmA(p + 1, p + len - 1, mm) == URI_SUCCESS,
      "host"
    );
  }

  if (uriIsWellFormedHostIp4A(p, p + len) == URI_TRUE) {
    return SUCCESS;
  }

  return php_uri_parser_rfc3986_validate_component_result(
    uriIsWellFormedHostRegNameA(p, p + len) == URI_TRUE,
    "host"
  );
}

ZEND_ATTRIBUTE_NONNULL zend_result php_uri_parser_rfc3986_port_validate(const zend_long port)
{
  char buf[MAX_LENGTH_OF_LONG + 1];
  const char *res = zend_print_long_to_buf(buf + sizeof(buf) - 1, port);

  const bool well_formed = uriIsWellFormedPortA(res, res + strlen(res));

  return php_uri_parser_rfc3986_validate_component_result(well_formed, "port");
}

ZEND_ATTRIBUTE_NONNULL zend_result php_uri_parser_rfc3986_path_validate(const zend_string *path)
{
  const char *p = ZSTR_VAL(path);
  const size_t len = ZSTR_LEN(path);
  /* The build() method checks whether the path begins with a "/" when there's a host.
   * In order to skip doing the same check, a false hasHost argument is passed to uriIsWellFormedPathA(). */
  const bool well_formed = uriIsWellFormedPathA(p, p + len, /* hasHost */ false);

  return php_uri_parser_rfc3986_validate_component_result(well_formed, "path");
}

ZEND_ATTRIBUTE_NONNULL zend_result php_uri_parser_rfc3986_query_validate(const zend_string *query)
{
  const char *p = ZSTR_VAL(query);
  const size_t len = ZSTR_LEN(query);
  const bool well_formed = uriIsWellFormedQueryA(p, p + len);

  return php_uri_parser_rfc3986_validate_component_result(well_formed, "query");
}

ZEND_ATTRIBUTE_NONNULL zend_result php_uri_parser_rfc3986_fragment_validate(const zend_string *fragment)
{
  const char *p = ZSTR_VAL(fragment);
  const size_t len = ZSTR_LEN(fragment);
  const bool well_formed = uriIsWellFormedFragmentA(p, p + len);

  return php_uri_parser_rfc3986_validate_component_result(well_formed, "fragment");
}

ZEND_ATTRIBUTE_NONNULL_ARGS(2,3,4,5,6,7,8) php_uri_parser_rfc3986_uris *php_uri_parser_rfc3986_build_from_zval(
  const php_uri_parser_rfc3986_uris *uriparser_base_uris,
  const zval *scheme, const zval *userinfo, const zval *host, const zval *port,
  const zval *path, const zval *query, const zval *fragment
) {
  php_uri_parser_rfc3986_uris *uriparser_uris = uriparser_create_uris();

  if (Z_STRLEN_P(path) > 0) {
    /* The first segment of the path must not contain ":" if the URI does not contain a scheme */
    if (Z_TYPE_P(scheme) == IS_NULL) {
      const char *p = Z_STRVAL_P(path);
      while (*p != '\0' && *p != '/') {
        if (*p == ':') {
          zend_throw_exception(php_uri_ce_invalid_uri_exception, "The path must not begin with \":\" when the URI does not contain a scheme", 0);
          goto failure;
        }

        p++;
      }
    }

    /* The path must not begin with "//" if the URI does not contain a host */
    if (Z_TYPE_P(host) == IS_NULL && zend_string_starts_with_literal(Z_STR_P(path), "//")) {
      zend_throw_exception(php_uri_ce_invalid_uri_exception, "The path must not begin with \"//\" when the URI does not contain a host", 0);
      goto failure;
    }
  }

  zend_result result = php_uri_parser_rfc3986_scheme_write(uriparser_uris, scheme, NULL);
  if (result == FAILURE) {
    goto failure;
  }
  result = php_uri_parser_rfc3986_host_write(uriparser_uris, host, NULL);
  if (result == FAILURE) {
    goto failure;
  }
  /* Intentionally writing userinfo after host to avoid error when the userinfo is set but the host is missing */
  result = php_uri_parser_rfc3986_userinfo_write(uriparser_uris, userinfo, NULL);
  if (result == FAILURE) {
    goto failure;
  }
  /* Intentionally writing userinfo after host to avoid error when the port is set but the host is missing */
  result = php_uri_parser_rfc3986_port_write(uriparser_uris, port, NULL);
  if (result == FAILURE) {
    goto failure;
  }
  result = php_uri_parser_rfc3986_path_write(uriparser_uris, path, NULL);
  if (result == FAILURE) {
    goto failure;
  }
  result = php_uri_parser_rfc3986_query_write(uriparser_uris, query, NULL);
  if (result == FAILURE) {
    goto failure;
  }
  result = php_uri_parser_rfc3986_fragment_write(uriparser_uris, fragment, NULL);
  if (result == FAILURE) {
    goto failure;
  }

  if (uriparser_base_uris != NULL) {
    UriUriA tmp = {0};

    if (php_uri_parser_rfc3986_add_base_url(&tmp, &uriparser_uris->uri, uriparser_base_uris, false) == FAILURE) {
      goto failure;
    }

    uriMakeOwnerMmA(&tmp, mm);
    uriFreeUriMembersMmA(&uriparser_uris->uri, mm);
    uriparser_uris->uri = tmp;
  }

  return uriparser_uris;

failure:
  uriFreeUriMembersMmA(&uriparser_uris->uri, mm);
  efree(uriparser_uris);
  return NULL;
}

PHPAPI const php_uri_parser php_uri_parser_rfc3986 = {
  .name = PHP_URI_PARSER_RFC3986,
  .parse = php_uri_parser_rfc3986_parse,
  .clone = php_uri_parser_rfc3986_clone,
  .to_string = php_uri_parser_rfc3986_to_string,
  .destroy = php_uri_parser_rfc3986_destroy,
  {
    .scheme = {.read = php_uri_parser_rfc3986_scheme_read, .write = php_uri_parser_rfc3986_scheme_write},
    .username = {.read = php_uri_parser_rfc3986_username_read, .write = NULL},
    .password = {.read = php_uri_parser_rfc3986_password_read, .write = NULL},
    .host = {.read = php_uri_parser_rfc3986_host_read, .write = php_uri_parser_rfc3986_host_write},
    .port = {.read = php_uri_parser_rfc3986_port_read, .write = php_uri_parser_rfc3986_port_write},
    .path = {.read = php_uri_parser_rfc3986_path_read, .write = php_uri_parser_rfc3986_path_write},
    .query = {.read = php_uri_parser_rfc3986_query_read, .write = php_uri_parser_rfc3986_query_write},
    .fragment = {.read = php_uri_parser_rfc3986_fragment_read, .write = php_uri_parser_rfc3986_fragment_write},
  }
};

Coverage Report

Created: 2026-10-28 06:20