/src/php-src/ext/uri/php_uri_common.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 "Zend/zend_interfaces.h"
#include "Zend/zend_exceptions.h"
#include "php_uri_common.h"

static zend_string *get_known_string_by_property_name(php_uri_property_name property_name)
{
  switch (property_name) {
    case PHP_URI_PROPERTY_NAME_SCHEME:
      return ZSTR_KNOWN(ZEND_STR_SCHEME);
    case PHP_URI_PROPERTY_NAME_USERNAME:
      return ZSTR_KNOWN(ZEND_STR_USERNAME);
    case PHP_URI_PROPERTY_NAME_PASSWORD:
      return ZSTR_KNOWN(ZEND_STR_PASSWORD);
    case PHP_URI_PROPERTY_NAME_HOST:
      return ZSTR_KNOWN(ZEND_STR_HOST);
    case PHP_URI_PROPERTY_NAME_PORT:
      return ZSTR_KNOWN(ZEND_STR_PORT);
    case PHP_URI_PROPERTY_NAME_PATH:
      return ZSTR_KNOWN(ZEND_STR_PATH);
    case PHP_URI_PROPERTY_NAME_QUERY:
      return ZSTR_KNOWN(ZEND_STR_QUERY);
    case PHP_URI_PROPERTY_NAME_FRAGMENT:
      return ZSTR_KNOWN(ZEND_STR_FRAGMENT);
    default: ZEND_UNREACHABLE();
  }
}

ZEND_ATTRIBUTE_NONNULL_ARGS(2) zend_result php_uri_pass_errors_by_ref_and_free(zval *errors_zv, HashTable *errors)
{
  /* The pass-by ref argument stored by errors_zv was not passed - the URI
   * implementation either doesn't support returning additional error information,
   * or the caller is not interested in it */
  if (errors_zv == NULL) {
    zend_array_release(errors);
    return SUCCESS;
  }

  ZEND_TRY_ASSIGN_REF_ARR(errors_zv, errors);
  if (EG(exception)) {
    return FAILURE;
  }

  return SUCCESS;
}

void php_uri_property_read_helper(INTERNAL_FUNCTION_PARAMETERS, php_uri_property_name property_name, php_uri_component_read_mode component_read_mode)
{
  ZEND_PARSE_PARAMETERS_NONE();

  php_uri_object *uri_object = Z_URI_OBJECT_P(ZEND_THIS);
  ZEND_ASSERT(uri_object->uri != NULL);

  const php_uri_property_handler *property_handler = php_uri_parser_property_handler_by_name(uri_object->parser, property_name);

  if (UNEXPECTED(property_handler->read(uri_object->uri, component_read_mode, return_value) == FAILURE)) {
    if (ZEND_HAS_OOM()) {
      zend_handle_delayed_oom();
      RETURN_THROWS();
    }
    zend_throw_exception_ex(php_uri_ce_error, 0, "The %pS component cannot be retrieved", get_known_string_by_property_name(property_name));
    RETURN_THROWS();
  }
}

static void php_uri_property_write_helper(INTERNAL_FUNCTION_PARAMETERS, php_uri_property_name property_name, const zval *property_zv)
{
  php_uri_object *old_uri_object = Z_URI_OBJECT_P(ZEND_THIS);
  ZEND_ASSERT(old_uri_object->uri != NULL);

  zend_object *new_object = old_uri_object->std.handlers->clone_obj(&old_uri_object->std);
  if (new_object == NULL) {
    RETURN_THROWS();
  }

  /* Assign the object early. The engine will take care of destruction in
   * case of an exception being thrown. */
  RETVAL_OBJ(new_object);

  const php_uri_property_handler *property_handler = php_uri_parser_property_handler_by_name(old_uri_object->parser, property_name);

  php_uri_object *new_uri_object = php_uri_object_from_obj(new_object);
  ZEND_ASSERT(new_uri_object->uri != NULL);
  if (UNEXPECTED(property_handler->write == NULL)) {
    zend_readonly_property_modification_error_ex(ZSTR_VAL(old_uri_object->std.ce->name),
      ZSTR_VAL(get_known_string_by_property_name(property_name)));
    RETURN_THROWS();
  }

  zval errors;
  ZVAL_UNDEF(&errors);
  if (UNEXPECTED(property_handler->write(new_uri_object->uri, property_zv, &errors) == FAILURE)) {
    zval_ptr_dtor(&errors);
    RETURN_THROWS();
  }

  ZEND_ASSERT(Z_ISUNDEF(errors));
}

void php_uri_property_write_str_helper(INTERNAL_FUNCTION_PARAMETERS, php_uri_property_name property_name)
{
  zend_string *value;

  ZEND_PARSE_PARAMETERS_START(1, 1)
    Z_PARAM_STR(value)
  ZEND_PARSE_PARAMETERS_END();

  zval zv;
  ZVAL_STR(&zv, value);

  php_uri_property_write_helper(INTERNAL_FUNCTION_PARAM_PASSTHRU, property_name, &zv);
}

void php_uri_property_write_str_or_null_helper(INTERNAL_FUNCTION_PARAMETERS, php_uri_property_name property_name)
{
  zend_string *value;

  ZEND_PARSE_PARAMETERS_START(1, 1)
    Z_PARAM_STR_OR_NULL(value)
  ZEND_PARSE_PARAMETERS_END();

  zval zv;
  if (value == NULL) {
    ZVAL_NULL(&zv);
  } else {
    ZVAL_STR(&zv, value);
  }

  php_uri_property_write_helper(INTERNAL_FUNCTION_PARAM_PASSTHRU, property_name, &zv);
}

void php_uri_property_write_long_or_null_helper(INTERNAL_FUNCTION_PARAMETERS, php_uri_property_name property_name)
{
  zend_long value;
  bool value_is_null;

  ZEND_PARSE_PARAMETERS_START(1, 1)
    Z_PARAM_LONG_OR_NULL(value, value_is_null)
  ZEND_PARSE_PARAMETERS_END();

  zval zv;
  if (value_is_null) {
    ZVAL_NULL(&zv);
  } else {
    ZVAL_LONG(&zv, value);
  }

  php_uri_property_write_helper(INTERNAL_FUNCTION_PARAM_PASSTHRU, property_name, &zv);
}

Line	Count	Source
1		/*
2		+----------------------------------------------------------------------+
3		\| Copyright © The PHP Group and Contributors. \|
4		+----------------------------------------------------------------------+
5		\| This source file is subject to the Modified BSD License that is \|
6		\| bundled with this package in the file LICENSE, and is available \|
7		\| through the World Wide Web at <https://www.php.net/license/>. \|
8		\| \|
9		\| SPDX-License-Identifier: BSD-3-Clause \|
10		+----------------------------------------------------------------------+
11		\| Authors: Máté Kocsis <kocsismate@php.net> \|
12		+----------------------------------------------------------------------+
13		*/
14
15		#include "php.h"
16		#include "Zend/zend_interfaces.h"
17		#include "Zend/zend_exceptions.h"
18		#include "php_uri_common.h"
19
20		static zend_string *get_known_string_by_property_name(php_uri_property_name property_name)
21	0	{
22	0	switch (property_name) {
23	0	case PHP_URI_PROPERTY_NAME_SCHEME:
24	0	return ZSTR_KNOWN(ZEND_STR_SCHEME);
25	0	case PHP_URI_PROPERTY_NAME_USERNAME:
26	0	return ZSTR_KNOWN(ZEND_STR_USERNAME);
27	0	case PHP_URI_PROPERTY_NAME_PASSWORD:
28	0	return ZSTR_KNOWN(ZEND_STR_PASSWORD);
29	0	case PHP_URI_PROPERTY_NAME_HOST:
30	0	return ZSTR_KNOWN(ZEND_STR_HOST);
31	0	case PHP_URI_PROPERTY_NAME_PORT:
32	0	return ZSTR_KNOWN(ZEND_STR_PORT);
33	0	case PHP_URI_PROPERTY_NAME_PATH:
34	0	return ZSTR_KNOWN(ZEND_STR_PATH);
35	0	case PHP_URI_PROPERTY_NAME_QUERY:
36	0	return ZSTR_KNOWN(ZEND_STR_QUERY);
37	0	case PHP_URI_PROPERTY_NAME_FRAGMENT:
38	0	return ZSTR_KNOWN(ZEND_STR_FRAGMENT);
39	0	default: ZEND_UNREACHABLE();
40	0	}
41	0	}
42
43		ZEND_ATTRIBUTE_NONNULL_ARGS(2) zend_result php_uri_pass_errors_by_ref_and_free(zval errors_zv, HashTable errors)
44	0	{
45		/* The pass-by ref argument stored by errors_zv was not passed - the URI
46		* implementation either doesn't support returning additional error information,
47		* or the caller is not interested in it */
48	0	if (errors_zv == NULL) {
49	0	zend_array_release(errors);
50	0	return SUCCESS;
51	0	}
52
53	0	ZEND_TRY_ASSIGN_REF_ARR(errors_zv, errors);
54	0	if (EG(exception)) {
55	0	return FAILURE;
56	0	}
57
58	0	return SUCCESS;
59	0	}
60
61		void php_uri_property_read_helper(INTERNAL_FUNCTION_PARAMETERS, php_uri_property_name property_name, php_uri_component_read_mode component_read_mode)
62	0	{
63	0	ZEND_PARSE_PARAMETERS_NONE();
64
65	0	php_uri_object *uri_object = Z_URI_OBJECT_P(ZEND_THIS);
66	0	ZEND_ASSERT(uri_object->uri != NULL);
67
68	0	const php_uri_property_handler *property_handler = php_uri_parser_property_handler_by_name(uri_object->parser, property_name);
69
70	0	if (UNEXPECTED(property_handler->read(uri_object->uri, component_read_mode, return_value) == FAILURE)) {
71	0	if (ZEND_HAS_OOM()) {
72	0	zend_handle_delayed_oom();
73	0	RETURN_THROWS();
74	0	}
75	0	zend_throw_exception_ex(php_uri_ce_error, 0, "The %pS component cannot be retrieved", get_known_string_by_property_name(property_name));
76	0	RETURN_THROWS();
77	0	}
78	0	}
79
80		static void php_uri_property_write_helper(INTERNAL_FUNCTION_PARAMETERS, php_uri_property_name property_name, const zval *property_zv)
81	0	{
82	0	php_uri_object *old_uri_object = Z_URI_OBJECT_P(ZEND_THIS);
83	0	ZEND_ASSERT(old_uri_object->uri != NULL);
84
85	0	zend_object *new_object = old_uri_object->std.handlers->clone_obj(&old_uri_object->std);
86	0	if (new_object == NULL) {
87	0	RETURN_THROWS();
88	0	}
89
90		/* Assign the object early. The engine will take care of destruction in
91		* case of an exception being thrown. */
92	0	RETVAL_OBJ(new_object);
93
94	0	const php_uri_property_handler *property_handler = php_uri_parser_property_handler_by_name(old_uri_object->parser, property_name);
95
96	0	php_uri_object *new_uri_object = php_uri_object_from_obj(new_object);
97	0	ZEND_ASSERT(new_uri_object->uri != NULL);
98	0	if (UNEXPECTED(property_handler->write == NULL)) {
99	0	zend_readonly_property_modification_error_ex(ZSTR_VAL(old_uri_object->std.ce->name),
100	0	ZSTR_VAL(get_known_string_by_property_name(property_name)));
101	0	RETURN_THROWS();
102	0	}
103
104	0	zval errors;
105	0	ZVAL_UNDEF(&errors);
106	0	if (UNEXPECTED(property_handler->write(new_uri_object->uri, property_zv, &errors) == FAILURE)) {
107	0	zval_ptr_dtor(&errors);
108	0	RETURN_THROWS();
109	0	}
110
111	0	ZEND_ASSERT(Z_ISUNDEF(errors));
112	0	}
113
114		void php_uri_property_write_str_helper(INTERNAL_FUNCTION_PARAMETERS, php_uri_property_name property_name)
115	0	{
116	0	zend_string *value;
117
118	0	ZEND_PARSE_PARAMETERS_START(1, 1)
119	0	Z_PARAM_STR(value)
120	0	ZEND_PARSE_PARAMETERS_END();
121
122	0	zval zv;
123	0	ZVAL_STR(&zv, value);
124
125	0	php_uri_property_write_helper(INTERNAL_FUNCTION_PARAM_PASSTHRU, property_name, &zv);
126	0	}
127
128		void php_uri_property_write_str_or_null_helper(INTERNAL_FUNCTION_PARAMETERS, php_uri_property_name property_name)
129	0	{
130	0	zend_string *value;
131
132	0	ZEND_PARSE_PARAMETERS_START(1, 1)
133	0	Z_PARAM_STR_OR_NULL(value)
134	0	ZEND_PARSE_PARAMETERS_END();
135
136	0	zval zv;
137	0	if (value == NULL) {
138	0	ZVAL_NULL(&zv);
139	0	} else {
140	0	ZVAL_STR(&zv, value);
141	0	}
142
143	0	php_uri_property_write_helper(INTERNAL_FUNCTION_PARAM_PASSTHRU, property_name, &zv);
144	0	}
145
146		void php_uri_property_write_long_or_null_helper(INTERNAL_FUNCTION_PARAMETERS, php_uri_property_name property_name)
147	0	{
148	0	zend_long value;
149	0	bool value_is_null;
150
151	0	ZEND_PARSE_PARAMETERS_START(1, 1)
152	0	Z_PARAM_LONG_OR_NULL(value, value_is_null)
153	0	ZEND_PARSE_PARAMETERS_END();
154
155	0	zval zv;
156	0	if (value_is_null) {
157	0	ZVAL_NULL(&zv);
158	0	} else {
159	0	ZVAL_LONG(&zv, value);
160	0	}
161
162	0	php_uri_property_write_helper(INTERNAL_FUNCTION_PARAM_PASSTHRU, property_name, &zv);
163	0	}

Coverage Report

Created: 2026-10-28 06:20