| /* |
| * |
| * Copyright 2015, Google Inc. |
| * All rights reserved. |
| * |
| * Redistribution and use in source and binary forms, with or without |
| * modification, are permitted provided that the following conditions are |
| * met: |
| * |
| * * Redistributions of source code must retain the above copyright |
| * notice, this list of conditions and the following disclaimer. |
| * * Redistributions in binary form must reproduce the above |
| * copyright notice, this list of conditions and the following disclaimer |
| * in the documentation and/or other materials provided with the |
| * distribution. |
| * * Neither the name of Google Inc. nor the names of its |
| * contributors may be used to endorse or promote products derived from |
| * this software without specific prior written permission. |
| * |
| * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
| * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
| * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
| * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
| * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
| * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
| * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
| * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
| * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
| * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
| * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| * |
| */ |
| |
| #include "channel.h" |
| |
| #ifdef HAVE_CONFIG_H |
| #include "config.h" |
| #endif |
| |
| #include <php.h> |
| #include <php_ini.h> |
| #include <ext/standard/info.h> |
| #include <ext/spl/spl_exceptions.h> |
| #include "php_grpc.h" |
| |
| #include <zend_exceptions.h> |
| |
| #include <stdbool.h> |
| |
| #include <grpc/grpc.h> |
| #include <grpc/grpc_security.h> |
| |
| #include "completion_queue.h" |
| #include "channel_credentials.h" |
| #include "server.h" |
| #include "timeval.h" |
| |
| zend_class_entry *grpc_ce_channel; |
| #if PHP_MAJOR_VERSION >= 7 |
| static zend_object_handlers channel_ce_handlers; |
| #endif |
| |
| /* Frees and destroys an instance of wrapped_grpc_channel */ |
| PHP_GRPC_FREE_WRAPPED_FUNC_START(wrapped_grpc_channel) |
| if (p->wrapped != NULL) { |
| grpc_channel_destroy(p->wrapped); |
| } |
| PHP_GRPC_FREE_WRAPPED_FUNC_END() |
| |
| /* Initializes an instance of wrapped_grpc_channel to be associated with an |
| * object of a class specified by class_type */ |
| php_grpc_zend_object create_wrapped_grpc_channel(zend_class_entry *class_type |
| TSRMLS_DC) { |
| PHP_GRPC_ALLOC_CLASS_OBJECT(wrapped_grpc_channel); |
| zend_object_std_init(&intern->std, class_type TSRMLS_CC); |
| object_properties_init(&intern->std, class_type); |
| PHP_GRPC_FREE_CLASS_OBJECT(wrapped_grpc_channel, channel_ce_handlers); |
| } |
| |
| void php_grpc_read_args_array(zval *args_array, |
| grpc_channel_args *args TSRMLS_DC) { |
| HashTable *array_hash; |
| int args_index; |
| array_hash = Z_ARRVAL_P(args_array); |
| if (!array_hash) { |
| zend_throw_exception(spl_ce_InvalidArgumentException, |
| "array_hash is NULL", 1 TSRMLS_CC); |
| return; |
| } |
| args->num_args = zend_hash_num_elements(array_hash); |
| args->args = ecalloc(args->num_args, sizeof(grpc_arg)); |
| args_index = 0; |
| |
| char *key = NULL; |
| zval *data; |
| int key_type; |
| |
| PHP_GRPC_HASH_FOREACH_STR_KEY_VAL_START(array_hash, key, key_type, data) |
| if (key_type != HASH_KEY_IS_STRING) { |
| zend_throw_exception(spl_ce_InvalidArgumentException, |
| "args keys must be strings", 1 TSRMLS_CC); |
| return; |
| } |
| args->args[args_index].key = key; |
| switch (Z_TYPE_P(data)) { |
| case IS_LONG: |
| args->args[args_index].value.integer = (int)Z_LVAL_P(data); |
| args->args[args_index].type = GRPC_ARG_INTEGER; |
| break; |
| case IS_STRING: |
| args->args[args_index].value.string = Z_STRVAL_P(data); |
| args->args[args_index].type = GRPC_ARG_STRING; |
| break; |
| default: |
| zend_throw_exception(spl_ce_InvalidArgumentException, |
| "args values must be int or string", 1 TSRMLS_CC); |
| return; |
| } |
| args_index++; |
| PHP_GRPC_HASH_FOREACH_END() |
| } |
| |
| /** |
| * Construct an instance of the Channel class. If the $args array contains a |
| * "credentials" key mapping to a ChannelCredentials object, a secure channel |
| * will be created with those credentials. |
| * @param string $target The hostname to associate with this channel |
| * @param array $args_array The arguments to pass to the Channel |
| */ |
| PHP_METHOD(Channel, __construct) { |
| wrapped_grpc_channel *channel = Z_WRAPPED_GRPC_CHANNEL_P(getThis()); |
| zval *creds_obj = NULL; |
| char *target; |
| php_grpc_int target_length; |
| zval *args_array = NULL; |
| grpc_channel_args args; |
| HashTable *array_hash; |
| wrapped_grpc_channel_credentials *creds = NULL; |
| |
| /* "sa" == 1 string, 1 array */ |
| if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "sa", &target, |
| &target_length, &args_array) == FAILURE) { |
| zend_throw_exception(spl_ce_InvalidArgumentException, |
| "Channel expects a string and an array", 1 TSRMLS_CC); |
| return; |
| } |
| array_hash = Z_ARRVAL_P(args_array); |
| if (php_grpc_zend_hash_find(array_hash, "credentials", sizeof("credentials"), |
| (void **)&creds_obj) == SUCCESS) { |
| if (Z_TYPE_P(creds_obj) == IS_NULL) { |
| creds = NULL; |
| php_grpc_zend_hash_del(array_hash, "credentials", sizeof("credentials")); |
| } else if (PHP_GRPC_GET_CLASS_ENTRY(creds_obj) != |
| grpc_ce_channel_credentials) { |
| zend_throw_exception(spl_ce_InvalidArgumentException, |
| "credentials must be a ChannelCredentials object", |
| 1 TSRMLS_CC); |
| return; |
| } else { |
| creds = Z_WRAPPED_GRPC_CHANNEL_CREDS_P(creds_obj); |
| php_grpc_zend_hash_del(array_hash, "credentials", sizeof("credentials")); |
| } |
| } |
| php_grpc_read_args_array(args_array, &args TSRMLS_CC); |
| if (creds == NULL) { |
| channel->wrapped = grpc_insecure_channel_create(target, &args, NULL); |
| } else { |
| channel->wrapped = |
| grpc_secure_channel_create(creds->wrapped, target, &args, NULL); |
| } |
| efree(args.args); |
| } |
| |
| /** |
| * Get the endpoint this call/stream is connected to |
| * @return string The URI of the endpoint |
| */ |
| PHP_METHOD(Channel, getTarget) { |
| wrapped_grpc_channel *channel = Z_WRAPPED_GRPC_CHANNEL_P(getThis()); |
| PHP_GRPC_RETURN_STRING(grpc_channel_get_target(channel->wrapped), 1); |
| } |
| |
| /** |
| * Get the connectivity state of the channel |
| * @param bool $try_to_connect Try to connect on the channel (optional) |
| * @return long The grpc connectivity state |
| */ |
| PHP_METHOD(Channel, getConnectivityState) { |
| wrapped_grpc_channel *channel = Z_WRAPPED_GRPC_CHANNEL_P(getThis()); |
| bool try_to_connect = false; |
| |
| /* "|b" == 1 optional bool */ |
| if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|b", &try_to_connect) |
| == FAILURE) { |
| zend_throw_exception(spl_ce_InvalidArgumentException, |
| "getConnectivityState expects a bool", 1 TSRMLS_CC); |
| return; |
| } |
| RETURN_LONG(grpc_channel_check_connectivity_state(channel->wrapped, |
| (int)try_to_connect)); |
| } |
| |
| /** |
| * Watch the connectivity state of the channel until it changed |
| * @param long $last_state The previous connectivity state of the channel |
| * @param Timeval $deadline_obj The deadline this function should wait until |
| * @return bool If the connectivity state changes from last_state |
| * before deadline |
| */ |
| PHP_METHOD(Channel, watchConnectivityState) { |
| wrapped_grpc_channel *channel = Z_WRAPPED_GRPC_CHANNEL_P(getThis()); |
| php_grpc_long last_state; |
| zval *deadline_obj; |
| |
| /* "lO" == 1 long 1 object */ |
| if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "lO", |
| &last_state, &deadline_obj, grpc_ce_timeval) == FAILURE) { |
| zend_throw_exception(spl_ce_InvalidArgumentException, |
| "watchConnectivityState expects 1 long 1 timeval", 1 TSRMLS_CC); |
| return; |
| } |
| |
| wrapped_grpc_timeval *deadline = Z_WRAPPED_GRPC_TIMEVAL_P(deadline_obj); |
| grpc_channel_watch_connectivity_state(channel->wrapped, |
| (grpc_connectivity_state)last_state, |
| deadline->wrapped, completion_queue, |
| NULL); |
| grpc_event event = |
| grpc_completion_queue_pluck(completion_queue, NULL, |
| gpr_inf_future(GPR_CLOCK_REALTIME), NULL); |
| RETURN_BOOL(event.success); |
| } |
| |
| /** |
| * Close the channel |
| * @return void |
| */ |
| PHP_METHOD(Channel, close) { |
| wrapped_grpc_channel *channel = Z_WRAPPED_GRPC_CHANNEL_P(getThis()); |
| if (channel->wrapped != NULL) { |
| grpc_channel_destroy(channel->wrapped); |
| channel->wrapped = NULL; |
| } |
| } |
| |
| ZEND_BEGIN_ARG_INFO_EX(arginfo_construct, 0, 0, 2) |
| ZEND_ARG_INFO(0, target) |
| ZEND_ARG_INFO(0, args) |
| ZEND_END_ARG_INFO() |
| |
| ZEND_BEGIN_ARG_INFO_EX(arginfo_getTarget, 0, 0, 0) |
| ZEND_END_ARG_INFO() |
| |
| ZEND_BEGIN_ARG_INFO_EX(arginfo_getConnectivityState, 0, 0, 0) |
| ZEND_ARG_INFO(0, try_to_connect) |
| ZEND_END_ARG_INFO() |
| |
| ZEND_BEGIN_ARG_INFO_EX(arginfo_watchConnectivityState, 0, 0, 2) |
| ZEND_ARG_INFO(0, last_state) |
| ZEND_ARG_INFO(0, deadline) |
| ZEND_END_ARG_INFO() |
| |
| ZEND_BEGIN_ARG_INFO_EX(arginfo_close, 0, 0, 0) |
| ZEND_END_ARG_INFO() |
| |
| static zend_function_entry channel_methods[] = { |
| PHP_ME(Channel, __construct, arginfo_construct, |
| ZEND_ACC_PUBLIC | ZEND_ACC_CTOR) |
| PHP_ME(Channel, getTarget, arginfo_getTarget, |
| ZEND_ACC_PUBLIC) |
| PHP_ME(Channel, getConnectivityState, arginfo_getConnectivityState, |
| ZEND_ACC_PUBLIC) |
| PHP_ME(Channel, watchConnectivityState, arginfo_watchConnectivityState, |
| ZEND_ACC_PUBLIC) |
| PHP_ME(Channel, close, arginfo_close, |
| ZEND_ACC_PUBLIC) |
| PHP_FE_END |
| }; |
| |
| void grpc_init_channel(TSRMLS_D) { |
| zend_class_entry ce; |
| INIT_CLASS_ENTRY(ce, "Grpc\\Channel", channel_methods); |
| ce.create_object = create_wrapped_grpc_channel; |
| grpc_ce_channel = zend_register_internal_class(&ce TSRMLS_CC); |
| PHP_GRPC_INIT_HANDLER(wrapped_grpc_channel, channel_ce_handlers); |
| } |