blob: a7942262987f79b0cfffa23816057326eb303f15 [file] [log] [blame]
Craig Tiller1a61b172015-02-16 11:53:47 -08001/*
2 *
Jan Tattermusch7897ae92017-06-07 22:57:36 +02003 * Copyright 2015 gRPC authors.
Craig Tiller1a61b172015-02-16 11:53:47 -08004 *
Jan Tattermusch7897ae92017-06-07 22:57:36 +02005 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
Craig Tiller1a61b172015-02-16 11:53:47 -08008 *
Jan Tattermusch7897ae92017-06-07 22:57:36 +02009 * http://www.apache.org/licenses/LICENSE-2.0
Craig Tiller1a61b172015-02-16 11:53:47 -080010 *
Jan Tattermusch7897ae92017-06-07 22:57:36 +020011 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
Craig Tiller1a61b172015-02-16 11:53:47 -080016 *
17 */
18
mlumishb892a272014-12-09 16:28:23 -080019#include "call.h"
20
murgatroid998242ba72015-04-01 15:29:44 -070021#include <ext/spl/spl_exceptions.h>
murgatroid998242ba72015-04-01 15:29:44 -070022#include <zend_exceptions.h>
mlumishb892a272014-12-09 16:28:23 -080023
murgatroid998242ba72015-04-01 15:29:44 -070024#include <grpc/support/alloc.h>
mlumishb892a272014-12-09 16:28:23 -080025
thinkerou771c2052018-05-15 10:37:43 +080026#include "call_credentials.h"
murgatroid99268acd52015-05-14 15:05:00 -070027#include "completion_queue.h"
mlumishb892a272014-12-09 16:28:23 -080028#include "timeval.h"
29#include "channel.h"
mlumishb892a272014-12-09 16:28:23 -080030#include "byte_buffer.h"
31
Xiaoguang Sun8a929a92015-03-13 14:22:31 +080032zend_class_entry *grpc_ce_call;
thinkeroufe037cb2018-05-16 12:51:28 +080033PHP_GRPC_DECLARE_OBJECT_HANDLER(call_ce_handlers)
Xiaoguang Sun8a929a92015-03-13 14:22:31 +080034
mlumishb892a272014-12-09 16:28:23 -080035/* Frees and destroys an instance of wrapped_grpc_call */
thinkerou011d1ef2016-07-27 09:44:49 +080036PHP_GRPC_FREE_WRAPPED_FUNC_START(wrapped_grpc_call)
37 if (p->owned && p->wrapped != NULL) {
Craig Tillerdd36b152017-03-31 08:27:28 -070038 grpc_call_unref(p->wrapped);
mlumishb892a272014-12-09 16:28:23 -080039 }
thinkerou011d1ef2016-07-27 09:44:49 +080040PHP_GRPC_FREE_WRAPPED_FUNC_END()
41
thinkerou03dc2192016-08-16 19:31:44 +080042/* Initializes an instance of wrapped_grpc_call to be associated with an
43 * object of a class specified by class_type */
thinkeroudba5b0c2016-07-27 18:39:16 +080044php_grpc_zend_object create_wrapped_grpc_call(zend_class_entry *class_type
45 TSRMLS_DC) {
thinkerouba75c012016-07-28 02:30:08 +080046 PHP_GRPC_ALLOC_CLASS_OBJECT(wrapped_grpc_call);
mlumishb892a272014-12-09 16:28:23 -080047 zend_object_std_init(&intern->std, class_type TSRMLS_CC);
48 object_properties_init(&intern->std, class_type);
thinkeroudc673c52016-07-28 09:49:38 +080049 PHP_GRPC_FREE_CLASS_OBJECT(wrapped_grpc_call, call_ce_handlers);
thinkeroudba5b0c2016-07-27 18:39:16 +080050}
thinkeroua3730b72016-07-20 16:59:54 +080051
52/* Creates and returns a PHP array object with the data in a
53 * grpc_metadata_array. Returns NULL on failure */
thinkerou6f9d30b2016-07-27 03:19:03 +080054zval *grpc_parse_metadata_array(grpc_metadata_array
55 *metadata_array TSRMLS_DC) {
thinkeroua3730b72016-07-20 16:59:54 +080056 int count = metadata_array->count;
57 grpc_metadata *elements = metadata_array->metadata;
thinkerou6f9d30b2016-07-27 03:19:03 +080058 zval *array;
59 PHP_GRPC_MAKE_STD_ZVAL(array);
60 array_init(array);
thinkeroua3730b72016-07-20 16:59:54 +080061 int i;
thinkeroua3730b72016-07-20 16:59:54 +080062 HashTable *array_hash;
thinkerou6f9d30b2016-07-27 03:19:03 +080063 zval *inner_array;
thinkeroua3730b72016-07-20 16:59:54 +080064 char *str_key;
65 char *str_val;
66 size_t key_len;
thinkerouba75c012016-07-28 02:30:08 +080067 zval *data = NULL;
thinkeroua3730b72016-07-20 16:59:54 +080068
thinkerou6f9d30b2016-07-27 03:19:03 +080069 array_hash = Z_ARRVAL_P(array);
thinkeroua3730b72016-07-20 16:59:54 +080070 grpc_metadata *elem;
71 for (i = 0; i < count; i++) {
72 elem = &elements[i];
Craig Tiller7c70b6c2017-01-23 07:48:42 -080073 key_len = GRPC_SLICE_LENGTH(elem->key);
thinkeroua3730b72016-07-20 16:59:54 +080074 str_key = ecalloc(key_len + 1, sizeof(char));
Craig Tiller7c70b6c2017-01-23 07:48:42 -080075 memcpy(str_key, GRPC_SLICE_START_PTR(elem->key), key_len);
76 str_val = ecalloc(GRPC_SLICE_LENGTH(elem->value) + 1, sizeof(char));
Stanley Cheung6a5c83d2017-02-16 12:25:32 -080077 memcpy(str_val, GRPC_SLICE_START_PTR(elem->value),
78 GRPC_SLICE_LENGTH(elem->value));
thinkerou5dafd822016-07-28 22:43:38 +080079 if (php_grpc_zend_hash_find(array_hash, str_key, key_len, (void **)&data)
80 == SUCCESS) {
thinkeroua3730b72016-07-20 16:59:54 +080081 if (Z_TYPE_P(data) != IS_ARRAY) {
thinkerou6f9d30b2016-07-27 03:19:03 +080082 zend_throw_exception(zend_exception_get_default(TSRMLS_C),
thinkeroua3730b72016-07-20 16:59:54 +080083 "Metadata hash somehow contains wrong types.",
thinkerou6f9d30b2016-07-27 03:19:03 +080084 1 TSRMLS_CC);
thinkeroua3730b72016-07-20 16:59:54 +080085 efree(str_key);
86 efree(str_val);
Zhouyihai Dingb0821f02018-01-23 20:38:02 -080087 PHP_GRPC_FREE_STD_ZVAL(array);
thinkerou6f9d30b2016-07-27 03:19:03 +080088 return NULL;
thinkeroua3730b72016-07-20 16:59:54 +080089 }
Stanley Cheung6a5c83d2017-02-16 12:25:32 -080090 php_grpc_add_next_index_stringl(data, str_val,
91 GRPC_SLICE_LENGTH(elem->value),
thinkerou6f9d30b2016-07-27 03:19:03 +080092 false);
thinkeroua3730b72016-07-20 16:59:54 +080093 } else {
thinkerou6f9d30b2016-07-27 03:19:03 +080094 PHP_GRPC_MAKE_STD_ZVAL(inner_array);
95 array_init(inner_array);
96 php_grpc_add_next_index_stringl(inner_array, str_val,
Craig Tiller7c70b6c2017-01-23 07:48:42 -080097 GRPC_SLICE_LENGTH(elem->value), false);
thinkerou6f9d30b2016-07-27 03:19:03 +080098 add_assoc_zval(array, str_key, inner_array);
Stanley Cheunge9595ba2017-05-09 15:43:58 -070099 PHP_GRPC_FREE_STD_ZVAL(inner_array);
thinkeroua3730b72016-07-20 16:59:54 +0800100 }
Stanley Cheunge9595ba2017-05-09 15:43:58 -0700101 efree(str_key);
102#if PHP_MAJOR_VERSION >= 7
103 efree(str_val);
104#endif
thinkeroua3730b72016-07-20 16:59:54 +0800105 }
thinkerou6f9d30b2016-07-27 03:19:03 +0800106 return array;
thinkeroua3730b72016-07-20 16:59:54 +0800107}
108
109/* Populates a grpc_metadata_array with the data in a PHP array object.
110 Returns true on success and false on failure */
111bool create_metadata_array(zval *array, grpc_metadata_array *metadata) {
thinkeroua3730b72016-07-20 16:59:54 +0800112 HashTable *array_hash;
113 HashTable *inner_array_hash;
thinkerou6f9d30b2016-07-27 03:19:03 +0800114 zval *value;
thinkerouba75c012016-07-28 02:30:08 +0800115 zval *inner_array;
Zhouyihai Dingec0669c2018-01-23 20:43:53 -0800116 grpc_metadata_array_init(metadata);
117 metadata->count = 0;
118 metadata->metadata = NULL;
thinkeroua3730b72016-07-20 16:59:54 +0800119 if (Z_TYPE_P(array) != IS_ARRAY) {
120 return false;
121 }
thinkerou6f9d30b2016-07-27 03:19:03 +0800122 array_hash = Z_ARRVAL_P(array);
thinkerouba75c012016-07-28 02:30:08 +0800123
thinkerou11cb5c52016-07-28 07:29:17 +0800124 char *key;
thinkerouba75c012016-07-28 02:30:08 +0800125 int key_type;
126 PHP_GRPC_HASH_FOREACH_STR_KEY_VAL_START(array_hash, key, key_type,
127 inner_array)
thinkerou11cb5c52016-07-28 07:29:17 +0800128 if (key_type != HASH_KEY_IS_STRING || key == NULL) {
thinkeroua3730b72016-07-20 16:59:54 +0800129 return false;
130 }
131 if (Z_TYPE_P(inner_array) != IS_ARRAY) {
132 return false;
133 }
thinkerouba75c012016-07-28 02:30:08 +0800134 inner_array_hash = Z_ARRVAL_P(inner_array);
thinkeroua3730b72016-07-20 16:59:54 +0800135 metadata->capacity += zend_hash_num_elements(inner_array_hash);
thinkerouba75c012016-07-28 02:30:08 +0800136 PHP_GRPC_HASH_FOREACH_END()
thinkeroua3730b72016-07-20 16:59:54 +0800137
138 metadata->metadata = gpr_malloc(metadata->capacity * sizeof(grpc_metadata));
139
thinkerouba75c012016-07-28 02:30:08 +0800140 char *key1 = NULL;
141 int key_type1;
142 PHP_GRPC_HASH_FOREACH_STR_KEY_VAL_START(array_hash, key1, key_type1,
143 inner_array)
144 if (key_type1 != HASH_KEY_IS_STRING) {
thinkerou6f9d30b2016-07-27 03:19:03 +0800145 return false;
146 }
Craig Tiller7c70b6c2017-01-23 07:48:42 -0800147 if (!grpc_header_key_is_legal(grpc_slice_from_static_string(key1))) {
Stanley Cheung129bca62016-08-26 19:54:57 -0700148 return false;
149 }
thinkerouba75c012016-07-28 02:30:08 +0800150 inner_array_hash = Z_ARRVAL_P(inner_array);
151 PHP_GRPC_HASH_FOREACH_VAL_START(inner_array_hash, value)
thinkeroua3730b72016-07-20 16:59:54 +0800152 if (Z_TYPE_P(value) != IS_STRING) {
153 return false;
154 }
Stanley Cheung6a5c83d2017-02-16 12:25:32 -0800155 metadata->metadata[metadata->count].key =
156 grpc_slice_from_copied_string(key1);
157 metadata->metadata[metadata->count].value =
158 grpc_slice_from_copied_buffer(Z_STRVAL_P(value), Z_STRLEN_P(value));
thinkeroua3730b72016-07-20 16:59:54 +0800159 metadata->count += 1;
thinkerouba75c012016-07-28 02:30:08 +0800160 PHP_GRPC_HASH_FOREACH_END()
161 PHP_GRPC_HASH_FOREACH_END()
thinkeroua3730b72016-07-20 16:59:54 +0800162 return true;
163}
164
ZhouyihaiDing04648792017-12-06 18:31:40 +0000165void grpc_php_metadata_array_destroy_including_entries(
166 grpc_metadata_array* array) {
167 size_t i;
168 if (array->metadata) {
169 for (i = 0; i < array->count; i++) {
170 grpc_slice_unref(array->metadata[i].key);
171 grpc_slice_unref(array->metadata[i].value);
172 }
173 }
174 grpc_metadata_array_destroy(array);
175}
176
thinkerou6f9d30b2016-07-27 03:19:03 +0800177/* Wraps a grpc_call struct in a PHP object. Owned indicates whether the
178 struct should be destroyed at the end of the object's lifecycle */
179zval *grpc_php_wrap_call(grpc_call *wrapped, bool owned TSRMLS_DC) {
180 zval *call_object;
181 PHP_GRPC_MAKE_STD_ZVAL(call_object);
182 object_init_ex(call_object, grpc_ce_call);
thinkeroufe037cb2018-05-16 12:51:28 +0800183 wrapped_grpc_call *call = PHP_GRPC_GET_WRAPPED_OBJECT(wrapped_grpc_call,
184 call_object);
thinkerou6f9d30b2016-07-27 03:19:03 +0800185 call->wrapped = wrapped;
186 call->owned = owned;
187 return call_object;
188}
thinkeroua3730b72016-07-20 16:59:54 +0800189
mlumishb892a272014-12-09 16:28:23 -0800190/**
191 * Constructs a new instance of the Call class.
thinkerou03dc2192016-08-16 19:31:44 +0800192 * @param Channel $channel_obj The channel to associate the call with.
193 * Must not be closed.
mlumishb892a272014-12-09 16:28:23 -0800194 * @param string $method The method to call
thinkerou03dc2192016-08-16 19:31:44 +0800195 * @param Timeval $deadline_obj The deadline for completing the call
thinkerouefbc9e72016-08-16 20:00:36 +0800196 * @param string $host_override The host is set by user (optional)
mlumishb892a272014-12-09 16:28:23 -0800197 */
Craig Tillerb5dcec52015-01-13 11:13:42 -0800198PHP_METHOD(Call, __construct) {
mlumishb892a272014-12-09 16:28:23 -0800199 zval *channel_obj;
200 char *method;
thinkerou19304682016-07-22 02:43:19 +0800201 php_grpc_int method_len;
mlumishb892a272014-12-09 16:28:23 -0800202 zval *deadline_obj;
Stanley Cheung478fb002015-08-19 14:25:00 -0700203 char *host_override = NULL;
thinkerou19304682016-07-22 02:43:19 +0800204 php_grpc_int host_override_len = 0;
thinkeroufe037cb2018-05-16 12:51:28 +0800205 wrapped_grpc_call *call = PHP_GRPC_GET_WRAPPED_OBJECT(wrapped_grpc_call,
206 getThis());
thinkeroua3730b72016-07-20 16:59:54 +0800207
Stanley Cheung478fb002015-08-19 14:25:00 -0700208 /* "OsO|s" == 1 Object, 1 string, 1 Object, 1 optional string */
thinkeroua3730b72016-07-20 16:59:54 +0800209 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "OsO|s", &channel_obj,
210 grpc_ce_channel, &method, &method_len,
211 &deadline_obj, grpc_ce_timeval, &host_override,
212 &host_override_len) == FAILURE) {
213 zend_throw_exception(spl_ce_InvalidArgumentException,
214 "Call expects a Channel, a String, a Timeval and "
215 "an optional String", 1 TSRMLS_CC);
mlumishb892a272014-12-09 16:28:23 -0800216 return;
217 }
thinkeroufe037cb2018-05-16 12:51:28 +0800218 wrapped_grpc_channel *channel =
219 PHP_GRPC_GET_WRAPPED_OBJECT(wrapped_grpc_channel, channel_obj);
Stanley Cheung5b3dc4a2017-08-03 18:00:25 -0700220 gpr_mu_lock(&channel->wrapper->mu);
ZhouyihaiDing9ef881e2018-04-12 16:43:33 -0700221 if (channel->wrapper == NULL || channel->wrapper->wrapped == NULL) {
mlumishb892a272014-12-09 16:28:23 -0800222 zend_throw_exception(spl_ce_InvalidArgumentException,
223 "Call cannot be constructed from a closed Channel",
224 1 TSRMLS_CC);
Stanley Cheung5b3dc4a2017-08-03 18:00:25 -0700225 gpr_mu_unlock(&channel->wrapper->mu);
mlumishb892a272014-12-09 16:28:23 -0800226 return;
227 }
228 add_property_zval(getThis(), "channel", channel_obj);
thinkeroufe037cb2018-05-16 12:51:28 +0800229 wrapped_grpc_timeval *deadline =
230 PHP_GRPC_GET_WRAPPED_OBJECT(wrapped_grpc_timeval, deadline_obj);
Craig Tiller7c70b6c2017-01-23 07:48:42 -0800231 grpc_slice method_slice = grpc_slice_from_copied_string(method);
232 grpc_slice host_slice = host_override != NULL ?
233 grpc_slice_from_copied_string(host_override) : grpc_empty_slice();
thinkeroua3730b72016-07-20 16:59:54 +0800234 call->wrapped =
Stanley Cheung5b3dc4a2017-08-03 18:00:25 -0700235 grpc_channel_create_call(channel->wrapper->wrapped, NULL,
236 GRPC_PROPAGATE_DEFAULTS,
Stanley Cheung6a5c83d2017-02-16 12:25:32 -0800237 completion_queue, method_slice,
238 host_override != NULL ? &host_slice : NULL,
thinkeroua3730b72016-07-20 16:59:54 +0800239 deadline->wrapped, NULL);
Craig Tiller7c70b6c2017-01-23 07:48:42 -0800240 grpc_slice_unref(method_slice);
241 grpc_slice_unref(host_slice);
Stanley Cheung51b36912016-06-29 15:05:59 -0700242 call->owned = true;
ZhouyihaiDing9ef881e2018-04-12 16:43:33 -0700243 call->channel = channel;
Stanley Cheung5b3dc4a2017-08-03 18:00:25 -0700244 gpr_mu_unlock(&channel->wrapper->mu);
mlumishb892a272014-12-09 16:28:23 -0800245}
246
247/**
murgatroid99afd541c2015-03-03 18:16:09 -0800248 * Start a batch of RPC actions.
thinkerouefbc9e72016-08-16 20:00:36 +0800249 * @param array $array Array of actions to take
murgatroid99afd541c2015-03-03 18:16:09 -0800250 * @return object Object with results of all actions
mlumishb892a272014-12-09 16:28:23 -0800251 */
murgatroid99c1d7e242015-04-02 10:02:43 -0700252PHP_METHOD(Call, startBatch) {
thinkerou6f9d30b2016-07-27 03:19:03 +0800253 zval *result;
254 PHP_GRPC_MAKE_STD_ZVAL(result);
255 object_init(result);
256 php_grpc_ulong index;
thinkeroua3730b72016-07-20 16:59:54 +0800257 zval *recv_status;
thinkeroua3730b72016-07-20 16:59:54 +0800258 zval *value;
259 zval *inner_value;
260 zval *message_value;
261 zval *message_flags;
thinkeroufe037cb2018-05-16 12:51:28 +0800262 wrapped_grpc_call *call = PHP_GRPC_GET_WRAPPED_OBJECT(wrapped_grpc_call,
263 getThis());
ZhouyihaiDing9ef881e2018-04-12 16:43:33 -0700264 if (call->channel) {
265 // startBatch in gRPC PHP server doesn't have channel in it.
266 if (call->channel->wrapper == NULL ||
267 call->channel->wrapper->wrapped == NULL) {
268 zend_throw_exception(spl_ce_RuntimeException,
269 "startBatch Error. Channel is closed",
270 1 TSRMLS_CC);
271 }
272 }
thinkeroua3730b72016-07-20 16:59:54 +0800273
274 grpc_op ops[8];
275 size_t op_num = 0;
276 zval *array;
277 HashTable *array_hash;
278 HashTable *status_hash;
279 HashTable *message_hash;
280
murgatroid99afd541c2015-03-03 18:16:09 -0800281 grpc_metadata_array metadata;
282 grpc_metadata_array trailing_metadata;
283 grpc_metadata_array recv_metadata;
284 grpc_metadata_array recv_trailing_metadata;
285 grpc_status_code status;
Craig Tiller7c70b6c2017-01-23 07:48:42 -0800286 grpc_slice recv_status_details = grpc_empty_slice();
287 grpc_slice send_status_details = grpc_empty_slice();
murgatroid99afd541c2015-03-03 18:16:09 -0800288 grpc_byte_buffer *message;
289 int cancelled;
290 grpc_call_error error;
murgatroid99afd541c2015-03-03 18:16:09 -0800291 char *message_str;
292 size_t message_len;
thinkeroua3730b72016-07-20 16:59:54 +0800293
murgatroid99afd541c2015-03-03 18:16:09 -0800294 grpc_metadata_array_init(&metadata);
295 grpc_metadata_array_init(&trailing_metadata);
murgatroid99d8bb9572015-03-11 09:18:06 -0700296 grpc_metadata_array_init(&recv_metadata);
297 grpc_metadata_array_init(&recv_trailing_metadata);
David Garcia Quintasa301eaa2016-05-06 16:59:03 -0700298 memset(ops, 0, sizeof(ops));
thinkeroua3730b72016-07-20 16:59:54 +0800299
murgatroid99afd541c2015-03-03 18:16:09 -0800300 /* "a" == 1 array */
301 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "a", &array) ==
Craig Tillerb5dcec52015-01-13 11:13:42 -0800302 FAILURE) {
mlumishb892a272014-12-09 16:28:23 -0800303 zend_throw_exception(spl_ce_InvalidArgumentException,
thinkerou11cb5c52016-07-28 07:29:17 +0800304 "start_batch expects an array", 1 TSRMLS_CC);
305 goto cleanup;
mlumishb892a272014-12-09 16:28:23 -0800306 }
thinkeroua3730b72016-07-20 16:59:54 +0800307
mlumishb892a272014-12-09 16:28:23 -0800308 array_hash = Z_ARRVAL_P(array);
thinkerouba75c012016-07-28 02:30:08 +0800309
310 char *key = NULL;
311 int key_type;
312 PHP_GRPC_HASH_FOREACH_LONG_KEY_VAL_START(array_hash, key, key_type, index,
thinkerou5dafd822016-07-28 22:43:38 +0800313 value)
thinkerou11cb5c52016-07-28 07:29:17 +0800314 if (key_type != HASH_KEY_IS_LONG || key != NULL) {
murgatroid995ca9f922015-02-03 11:21:11 -0800315 zend_throw_exception(spl_ce_InvalidArgumentException,
murgatroid99afd541c2015-03-03 18:16:09 -0800316 "batch keys must be integers", 1 TSRMLS_CC);
317 goto cleanup;
murgatroid995ca9f922015-02-03 11:21:11 -0800318 }
thinkeroub4084692017-09-25 10:09:34 +0800319
320 ops[op_num].op = (grpc_op_type)index;
321 ops[op_num].flags = 0;
322 ops[op_num].reserved = NULL;
323
murgatroid99afd541c2015-03-03 18:16:09 -0800324 switch(index) {
thinkeroua3730b72016-07-20 16:59:54 +0800325 case GRPC_OP_SEND_INITIAL_METADATA:
thinkerouba75c012016-07-28 02:30:08 +0800326 if (!create_metadata_array(value, &metadata)) {
murgatroid995ca9f922015-02-03 11:21:11 -0800327 zend_throw_exception(spl_ce_InvalidArgumentException,
thinkeroua3730b72016-07-20 16:59:54 +0800328 "Bad metadata value given", 1 TSRMLS_CC);
murgatroid99afd541c2015-03-03 18:16:09 -0800329 goto cleanup;
thinkeroua3730b72016-07-20 16:59:54 +0800330 }
thinkerou5dafd822016-07-28 22:43:38 +0800331 ops[op_num].data.send_initial_metadata.count = metadata.count;
332 ops[op_num].data.send_initial_metadata.metadata = metadata.metadata;
thinkeroua3730b72016-07-20 16:59:54 +0800333 break;
334 case GRPC_OP_SEND_MESSAGE:
thinkerouba75c012016-07-28 02:30:08 +0800335 if (Z_TYPE_P(value) != IS_ARRAY) {
thinkeroua3730b72016-07-20 16:59:54 +0800336 zend_throw_exception(spl_ce_InvalidArgumentException,
337 "Expected an array for send message",
338 1 TSRMLS_CC);
339 goto cleanup;
340 }
thinkerouba75c012016-07-28 02:30:08 +0800341 message_hash = Z_ARRVAL_P(value);
342 if (php_grpc_zend_hash_find(message_hash, "flags", sizeof("flags"),
thinkeroua3730b72016-07-20 16:59:54 +0800343 (void **)&message_flags) == SUCCESS) {
thinkerouba75c012016-07-28 02:30:08 +0800344 if (Z_TYPE_P(message_flags) != IS_LONG) {
thinkeroua3730b72016-07-20 16:59:54 +0800345 zend_throw_exception(spl_ce_InvalidArgumentException,
346 "Expected an int for message flags",
347 1 TSRMLS_CC);
348 }
thinkerouba75c012016-07-28 02:30:08 +0800349 ops[op_num].flags = Z_LVAL_P(message_flags) & GRPC_WRITE_USED_MASK;
thinkeroua3730b72016-07-20 16:59:54 +0800350 }
thinkerouba75c012016-07-28 02:30:08 +0800351 if (php_grpc_zend_hash_find(message_hash, "message", sizeof("message"),
thinkeroua3730b72016-07-20 16:59:54 +0800352 (void **)&message_value) != SUCCESS ||
thinkerouba75c012016-07-28 02:30:08 +0800353 Z_TYPE_P(message_value) != IS_STRING) {
thinkeroua3730b72016-07-20 16:59:54 +0800354 zend_throw_exception(spl_ce_InvalidArgumentException,
355 "Expected a string for send message",
356 1 TSRMLS_CC);
357 goto cleanup;
358 }
Mark D. Roth448c1f02017-01-25 10:44:30 -0800359 ops[op_num].data.send_message.send_message =
thinkerouba75c012016-07-28 02:30:08 +0800360 string_to_byte_buffer(Z_STRVAL_P(message_value),
361 Z_STRLEN_P(message_value));
thinkeroua3730b72016-07-20 16:59:54 +0800362 break;
363 case GRPC_OP_SEND_CLOSE_FROM_CLIENT:
364 break;
365 case GRPC_OP_SEND_STATUS_FROM_SERVER:
thinkerouba75c012016-07-28 02:30:08 +0800366 status_hash = Z_ARRVAL_P(value);
367 if (php_grpc_zend_hash_find(status_hash, "metadata", sizeof("metadata"),
thinkeroua3730b72016-07-20 16:59:54 +0800368 (void **)&inner_value) == SUCCESS) {
thinkerouba75c012016-07-28 02:30:08 +0800369 if (!create_metadata_array(inner_value, &trailing_metadata)) {
thinkeroua3730b72016-07-20 16:59:54 +0800370 zend_throw_exception(spl_ce_InvalidArgumentException,
371 "Bad trailing metadata value given",
372 1 TSRMLS_CC);
373 goto cleanup;
374 }
375 ops[op_num].data.send_status_from_server.trailing_metadata =
376 trailing_metadata.metadata;
377 ops[op_num].data.send_status_from_server.trailing_metadata_count =
378 trailing_metadata.count;
379 }
thinkerouba75c012016-07-28 02:30:08 +0800380 if (php_grpc_zend_hash_find(status_hash, "code", sizeof("code"),
thinkeroua3730b72016-07-20 16:59:54 +0800381 (void**)&inner_value) == SUCCESS) {
thinkerouba75c012016-07-28 02:30:08 +0800382 if (Z_TYPE_P(inner_value) != IS_LONG) {
thinkeroua3730b72016-07-20 16:59:54 +0800383 zend_throw_exception(spl_ce_InvalidArgumentException,
384 "Status code must be an integer",
385 1 TSRMLS_CC);
386 goto cleanup;
387 }
388 ops[op_num].data.send_status_from_server.status =
thinkerouba75c012016-07-28 02:30:08 +0800389 Z_LVAL_P(inner_value);
thinkeroua3730b72016-07-20 16:59:54 +0800390 } else {
391 zend_throw_exception(spl_ce_InvalidArgumentException,
392 "Integer status code is required",
393 1 TSRMLS_CC);
394 goto cleanup;
395 }
thinkerouba75c012016-07-28 02:30:08 +0800396 if (php_grpc_zend_hash_find(status_hash, "details", sizeof("details"),
thinkeroua3730b72016-07-20 16:59:54 +0800397 (void**)&inner_value) == SUCCESS) {
thinkerouba75c012016-07-28 02:30:08 +0800398 if (Z_TYPE_P(inner_value) != IS_STRING) {
thinkeroua3730b72016-07-20 16:59:54 +0800399 zend_throw_exception(spl_ce_InvalidArgumentException,
400 "Status details must be a string",
401 1 TSRMLS_CC);
402 goto cleanup;
403 }
Stanley Cheung6a5c83d2017-02-16 12:25:32 -0800404 send_status_details = grpc_slice_from_copied_string(
405 Z_STRVAL_P(inner_value));
406 ops[op_num].data.send_status_from_server.status_details =
407 &send_status_details;
thinkeroua3730b72016-07-20 16:59:54 +0800408 } else {
409 zend_throw_exception(spl_ce_InvalidArgumentException,
410 "String status details is required",
411 1 TSRMLS_CC);
412 goto cleanup;
413 }
414 break;
415 case GRPC_OP_RECV_INITIAL_METADATA:
Mark D. Roth448c1f02017-01-25 10:44:30 -0800416 ops[op_num].data.recv_initial_metadata.recv_initial_metadata =
417 &recv_metadata;
thinkeroua3730b72016-07-20 16:59:54 +0800418 break;
419 case GRPC_OP_RECV_MESSAGE:
Mark D. Roth448c1f02017-01-25 10:44:30 -0800420 ops[op_num].data.recv_message.recv_message = &message;
thinkeroua3730b72016-07-20 16:59:54 +0800421 break;
422 case GRPC_OP_RECV_STATUS_ON_CLIENT:
423 ops[op_num].data.recv_status_on_client.trailing_metadata =
424 &recv_trailing_metadata;
425 ops[op_num].data.recv_status_on_client.status = &status;
426 ops[op_num].data.recv_status_on_client.status_details =
Craig Tiller7c70b6c2017-01-23 07:48:42 -0800427 &recv_status_details;
thinkeroua3730b72016-07-20 16:59:54 +0800428 break;
429 case GRPC_OP_RECV_CLOSE_ON_SERVER:
430 ops[op_num].data.recv_close_on_server.cancelled = &cancelled;
431 break;
432 default:
433 zend_throw_exception(spl_ce_InvalidArgumentException,
434 "Unrecognized key in batch", 1 TSRMLS_CC);
435 goto cleanup;
murgatroid99afd541c2015-03-03 18:16:09 -0800436 }
murgatroid99afd541c2015-03-03 18:16:09 -0800437 op_num++;
thinkerouba75c012016-07-28 02:30:08 +0800438 PHP_GRPC_HASH_FOREACH_END()
thinkeroua3730b72016-07-20 16:59:54 +0800439
Nicolas "Pixel" Noble150b7c42015-08-01 01:15:10 +0200440 error = grpc_call_start_batch(call->wrapped, ops, op_num, call->wrapped,
441 NULL);
murgatroid99afd541c2015-03-03 18:16:09 -0800442 if (error != GRPC_CALL_OK) {
443 zend_throw_exception(spl_ce_LogicException,
444 "start_batch was called incorrectly",
445 (long)error TSRMLS_CC);
446 goto cleanup;
447 }
Stanley Cheungc0c9ba92015-08-18 16:19:38 -0700448 grpc_completion_queue_pluck(completion_queue, call->wrapped,
449 gpr_inf_future(GPR_CLOCK_REALTIME), NULL);
thinkerouba75c012016-07-28 02:30:08 +0800450#if PHP_MAJOR_VERSION >= 7
Stanley Cheunge9595ba2017-05-09 15:43:58 -0700451 zval *recv_md;
thinkerouba75c012016-07-28 02:30:08 +0800452#endif
murgatroid99afd541c2015-03-03 18:16:09 -0800453 for (int i = 0; i < op_num; i++) {
454 switch(ops[i].op) {
thinkeroua3730b72016-07-20 16:59:54 +0800455 case GRPC_OP_SEND_INITIAL_METADATA:
456 add_property_bool(result, "send_metadata", true);
457 break;
458 case GRPC_OP_SEND_MESSAGE:
459 add_property_bool(result, "send_message", true);
460 break;
461 case GRPC_OP_SEND_CLOSE_FROM_CLIENT:
462 add_property_bool(result, "send_close", true);
463 break;
464 case GRPC_OP_SEND_STATUS_FROM_SERVER:
465 add_property_bool(result, "send_status", true);
466 break;
467 case GRPC_OP_RECV_INITIAL_METADATA:
thinkerouba75c012016-07-28 02:30:08 +0800468#if PHP_MAJOR_VERSION < 7
thinkeroua3730b72016-07-20 16:59:54 +0800469 array = grpc_parse_metadata_array(&recv_metadata TSRMLS_CC);
470 add_property_zval(result, "metadata", array);
thinkeroua3730b72016-07-20 16:59:54 +0800471#else
Stanley Cheunge9595ba2017-05-09 15:43:58 -0700472 recv_md = grpc_parse_metadata_array(&recv_metadata);
473 add_property_zval(result, "metadata", recv_md);
474 zval_ptr_dtor(recv_md);
475 PHP_GRPC_FREE_STD_ZVAL(recv_md);
thinkerouba75c012016-07-28 02:30:08 +0800476#endif
477 PHP_GRPC_DELREF(array);
thinkeroua3730b72016-07-20 16:59:54 +0800478 break;
479 case GRPC_OP_RECV_MESSAGE:
480 byte_buffer_to_string(message, &message_str, &message_len);
481 if (message_str == NULL) {
thinkerou6f9d30b2016-07-27 03:19:03 +0800482 add_property_null(result, "message");
thinkeroua3730b72016-07-20 16:59:54 +0800483 } else {
thinkerouba75c012016-07-28 02:30:08 +0800484 php_grpc_add_property_stringl(result, "message", message_str,
485 message_len, false);
thinkeroua3730b72016-07-20 16:59:54 +0800486 }
487 break;
488 case GRPC_OP_RECV_STATUS_ON_CLIENT:
Stanley Cheunge9595ba2017-05-09 15:43:58 -0700489 PHP_GRPC_MAKE_STD_ZVAL(recv_status);
490 object_init(recv_status);
thinkerouba75c012016-07-28 02:30:08 +0800491#if PHP_MAJOR_VERSION < 7
492 array = grpc_parse_metadata_array(&recv_trailing_metadata TSRMLS_CC);
493 add_property_zval(recv_status, "metadata", array);
494#else
Stanley Cheunge9595ba2017-05-09 15:43:58 -0700495 recv_md = grpc_parse_metadata_array(&recv_trailing_metadata);
496 add_property_zval(recv_status, "metadata", recv_md);
497 zval_ptr_dtor(recv_md);
498 PHP_GRPC_FREE_STD_ZVAL(recv_md);
thinkerouba75c012016-07-28 02:30:08 +0800499#endif
500 PHP_GRPC_DELREF(array);
501 add_property_long(recv_status, "code", status);
Craig Tiller7c70b6c2017-01-23 07:48:42 -0800502 char *status_details_text = grpc_slice_to_c_string(recv_status_details);
503 php_grpc_add_property_string(recv_status, "details", status_details_text,
Stanley Cheung8e565022016-07-28 10:32:43 -0700504 true);
Craig Tiller7c70b6c2017-01-23 07:48:42 -0800505 gpr_free(status_details_text);
thinkerouba75c012016-07-28 02:30:08 +0800506 add_property_zval(result, "status", recv_status);
Stanley Cheunge9595ba2017-05-09 15:43:58 -0700507#if PHP_MAJOR_VERSION >= 7
508 zval_ptr_dtor(recv_status);
509#endif
thinkerouba75c012016-07-28 02:30:08 +0800510 PHP_GRPC_DELREF(recv_status);
thinkerou8d770142017-01-10 13:26:42 +0800511 PHP_GRPC_FREE_STD_ZVAL(recv_status);
thinkeroua3730b72016-07-20 16:59:54 +0800512 break;
513 case GRPC_OP_RECV_CLOSE_ON_SERVER:
thinkerou6f9d30b2016-07-27 03:19:03 +0800514 add_property_bool(result, "cancelled", cancelled);
thinkeroua3730b72016-07-20 16:59:54 +0800515 break;
516 default:
517 break;
518 }
519 }
thinkeroua3730b72016-07-20 16:59:54 +0800520
murgatroid99afd541c2015-03-03 18:16:09 -0800521cleanup:
ZhouyihaiDing04648792017-12-06 18:31:40 +0000522 grpc_php_metadata_array_destroy_including_entries(&metadata);
523 grpc_php_metadata_array_destroy_including_entries(&trailing_metadata);
murgatroid99afd541c2015-03-03 18:16:09 -0800524 grpc_metadata_array_destroy(&recv_metadata);
525 grpc_metadata_array_destroy(&recv_trailing_metadata);
Craig Tiller7c70b6c2017-01-23 07:48:42 -0800526 grpc_slice_unref(recv_status_details);
527 grpc_slice_unref(send_status_details);
Stanley Cheung82e6f322016-04-06 11:51:57 -0700528 for (int i = 0; i < op_num; i++) {
529 if (ops[i].op == GRPC_OP_SEND_MESSAGE) {
Mark D. Roth448c1f02017-01-25 10:44:30 -0800530 grpc_byte_buffer_destroy(ops[i].data.send_message.send_message);
Stanley Cheung82e6f322016-04-06 11:51:57 -0700531 }
532 if (ops[i].op == GRPC_OP_RECV_MESSAGE) {
533 grpc_byte_buffer_destroy(message);
thinkerou8d770142017-01-10 13:26:42 +0800534 PHP_GRPC_FREE_STD_ZVAL(message_str);
Stanley Cheung82e6f322016-04-06 11:51:57 -0700535 }
536 }
murgatroid99afd541c2015-03-03 18:16:09 -0800537 RETURN_DESTROY_ZVAL(result);
mlumishb892a272014-12-09 16:28:23 -0800538}
539
murgatroid99c1da8f22015-03-25 11:33:05 -0700540/**
Stanley Cheungdb98e082015-07-27 10:19:45 -0700541 * Get the endpoint this call/stream is connected to
542 * @return string The URI of the endpoint
543 */
544PHP_METHOD(Call, getPeer) {
thinkeroufe037cb2018-05-16 12:51:28 +0800545 wrapped_grpc_call *call = PHP_GRPC_GET_WRAPPED_OBJECT(wrapped_grpc_call,
546 getThis());
Zhouyihai Ding159ceb62018-01-23 20:39:36 -0800547 char *peer = grpc_call_get_peer(call->wrapped);
548 PHP_GRPC_RETVAL_STRING(peer, 1);
549 gpr_free(peer);
Stanley Cheungdb98e082015-07-27 10:19:45 -0700550}
551
552/**
thinkerouefbc9e72016-08-16 20:00:36 +0800553 * Cancel the call. This will cause the call to end with STATUS_CANCELLED
554 * if it has not already ended with another status.
555 * @return void
murgatroid99c1da8f22015-03-25 11:33:05 -0700556 */
557PHP_METHOD(Call, cancel) {
thinkeroufe037cb2018-05-16 12:51:28 +0800558 wrapped_grpc_call *call = PHP_GRPC_GET_WRAPPED_OBJECT(wrapped_grpc_call,
559 getThis());
Nicolas "Pixel" Noble150b7c42015-08-01 01:15:10 +0200560 grpc_call_cancel(call->wrapped, NULL);
murgatroid99c1da8f22015-03-25 11:33:05 -0700561}
562
Stanley Cheung35805802015-12-10 11:42:55 -0800563/**
564 * Set the CallCredentials for this call.
thinkerouefbc9e72016-08-16 20:00:36 +0800565 * @param CallCredentials $creds_obj The CallCredentials object
566 * @return int The error code
Stanley Cheung35805802015-12-10 11:42:55 -0800567 */
568PHP_METHOD(Call, setCredentials) {
569 zval *creds_obj;
570
571 /* "O" == 1 Object */
572 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "O", &creds_obj,
573 grpc_ce_call_credentials) == FAILURE) {
574 zend_throw_exception(spl_ce_InvalidArgumentException,
575 "setCredentials expects 1 CallCredentials",
576 1 TSRMLS_CC);
577 return;
578 }
579
thinkeroua3730b72016-07-20 16:59:54 +0800580 wrapped_grpc_call_credentials *creds =
thinkeroufe037cb2018-05-16 12:51:28 +0800581 PHP_GRPC_GET_WRAPPED_OBJECT(wrapped_grpc_call_credentials, creds_obj);
582 wrapped_grpc_call *call = PHP_GRPC_GET_WRAPPED_OBJECT(wrapped_grpc_call,
583 getThis());
Stanley Cheung35805802015-12-10 11:42:55 -0800584
585 grpc_call_error error = GRPC_CALL_ERROR;
586 error = grpc_call_set_credentials(call->wrapped, creds->wrapped);
587 RETURN_LONG(error);
588}
589
Stanley Cheung6a5c83d2017-02-16 12:25:32 -0800590ZEND_BEGIN_ARG_INFO_EX(arginfo_construct, 0, 0, 3)
591 ZEND_ARG_INFO(0, channel)
592 ZEND_ARG_INFO(0, method)
593 ZEND_ARG_INFO(0, deadline)
594 ZEND_ARG_INFO(0, host_override)
595ZEND_END_ARG_INFO()
596
597ZEND_BEGIN_ARG_INFO_EX(arginfo_startBatch, 0, 0, 1)
598 ZEND_ARG_INFO(0, ops)
599ZEND_END_ARG_INFO()
600
601ZEND_BEGIN_ARG_INFO_EX(arginfo_getPeer, 0, 0, 0)
602ZEND_END_ARG_INFO()
603
604ZEND_BEGIN_ARG_INFO_EX(arginfo_cancel, 0, 0, 0)
605ZEND_END_ARG_INFO()
606
607ZEND_BEGIN_ARG_INFO_EX(arginfo_setCredentials, 0, 0, 1)
608 ZEND_ARG_INFO(0, credentials)
609ZEND_END_ARG_INFO()
610
mlumishb892a272014-12-09 16:28:23 -0800611static zend_function_entry call_methods[] = {
Stanley Cheung6a5c83d2017-02-16 12:25:32 -0800612 PHP_ME(Call, __construct, arginfo_construct, ZEND_ACC_PUBLIC | ZEND_ACC_CTOR)
613 PHP_ME(Call, startBatch, arginfo_startBatch, ZEND_ACC_PUBLIC)
614 PHP_ME(Call, getPeer, arginfo_getPeer, ZEND_ACC_PUBLIC)
615 PHP_ME(Call, cancel, arginfo_cancel, ZEND_ACC_PUBLIC)
616 PHP_ME(Call, setCredentials, arginfo_setCredentials, ZEND_ACC_PUBLIC)
thinkeroua3730b72016-07-20 16:59:54 +0800617 PHP_FE_END
618};
mlumishb892a272014-12-09 16:28:23 -0800619
Craig Tillerb5dcec52015-01-13 11:13:42 -0800620void grpc_init_call(TSRMLS_D) {
mlumishb892a272014-12-09 16:28:23 -0800621 zend_class_entry ce;
622 INIT_CLASS_ENTRY(ce, "Grpc\\Call", call_methods);
623 ce.create_object = create_wrapped_grpc_call;
624 grpc_ce_call = zend_register_internal_class(&ce TSRMLS_CC);
thinkerou5dafd822016-07-28 22:43:38 +0800625 PHP_GRPC_INIT_HANDLER(wrapped_grpc_call, call_ce_handlers);
mlumishb892a272014-12-09 16:28:23 -0800626}