├── .gitignore ├── tests ├── composer.json ├── TestServiceClient.php └── testClient.php ├── proto ├── rpc.proto ├── message.proto └── generate.sh ├── README.md ├── composer.json ├── GPBMetadata ├── Rpc.php └── Message.php ├── App ├── Message │ ├── TestResponse.php │ └── TestRequest.php └── Service │ ├── TestServiceService.php │ └── TestService.php ├── config └── debug │ └── config.php ├── grpc ├── Entrance.php └── server │ └── MainServer.php ├── grpc_generator ├── php_generator.h ├── php_generator_helpers.h ├── php_plugin.cc └── php_generator.cc ├── run.php └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | .idea/ 2 | composer.lock 3 | vendor/ 4 | *.pid 5 | test/vendor 6 | test/composer.lock 7 | -------------------------------------------------------------------------------- /tests/composer.json: -------------------------------------------------------------------------------- 1 | { 2 | "require": { 3 | "google/protobuf": "^3.3.0", 4 | "grpc/grpc": "^1.3.4" 5 | } 6 | } -------------------------------------------------------------------------------- /proto/rpc.proto: -------------------------------------------------------------------------------- 1 | syntax = "proto3"; 2 | 3 | package App.Service; 4 | 5 | import "message.proto"; 6 | 7 | service TestService 8 | { 9 | rpc Test(Message.TestRequest) returns (Message.TestResponse) {} 10 | } -------------------------------------------------------------------------------- /proto/message.proto: -------------------------------------------------------------------------------- 1 | syntax = "proto3"; 2 | 3 | package App.Message; 4 | 5 | message TestRequest { 6 | bytes name = 1; 7 | int64 id = 2; 8 | bool flag = 3; 9 | } 10 | 11 | message TestResponse { 12 | int64 status = 1; 13 | } -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # swoole-grpc 2 | Grpc Implement base on Swoole Http2 Server 3 | 4 | # Document 5 | 6 | # Require 7 | 8 | * protobuf 3.3 + 9 | * grpc 10 | * Swoole 1.9.9 + 11 | 12 | # Install 13 | 14 | ## 安装Swoole扩展 15 | 16 | 需要开启Swoole扩展的http2和openssl支持 17 | 18 | ```bash 19 | ./configure --enable-async-redis --enable-http2 --enable-openssl 20 | make clean && make && make install 21 | ``` 22 | 23 | # GRPC生成器 24 | 25 | 由于GRPC本身不支持PHP Server，因此原本的生成器也不支持生成Server端的代码。因此我修改了grpc php generator的代码，使用时，将grpc_generator目录下的文件复制到grpc的`src/compiler`目录下，然后重新编译安装即可。 -------------------------------------------------------------------------------- /proto/generate.sh: -------------------------------------------------------------------------------- 1 | CURRENT_PATH=`pwd` 2 | PROJECT_PATH=$(dirname $(pwd)) 3 | 4 | PROTO_PATH=$CURRENT_PATH 5 | PHP_OUT=$PROJECT_PATH 6 | GRPC_OUT=$PROJECT_PATH 7 | 8 | GRPC_PLUGIN_PATH=/Users/lidanyang/Software/lib/grpc/bins/opt/grpc_php_plugin 9 | PROTOC_PATH=/usr/local/protobuf/bin/protoc 10 | 11 | 12 | for file in $PROTO_PATH/* 13 | do 14 | if [ "${file##*.}" = "proto" ]; 15 | then 16 | FILE_LIST=${FILE_LIST}" ${file}"; 17 | fi 18 | done 19 | 20 | $PROTOC_PATH --proto_path=$PROTO_PATH --php_out=$PHP_OUT --grpc_out=$GRPC_OUT --plugin=protoc-gen-grpc=$GRPC_PLUGIN_PATH $FILE_LIST -------------------------------------------------------------------------------- /composer.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "cat-sys/swoole-grpc", 3 | "description": "Grpc Implement base on Swoole Http2 Server", 4 | "authors": [ 5 | { 6 | "name": "lidanyang", 7 | "email": "lancelot2014@foxmail.com" 8 | } 9 | ], 10 | "require": { 11 | "php": ">=7", 12 | "ext-swoole": ">=1.9.10", 13 | "google/protobuf": "^3.3.0", 14 | "cat-sys/cat-core": "dev-master" 15 | }, 16 | "autoload": { 17 | "psr-4": { 18 | "grpc\\":"grpc/", 19 | "App\\":"App/", 20 | "GPBMetadata\\":"GPBMetadata/" 21 | }, 22 | "classmap": [ 23 | "proto" 24 | ] 25 | } 26 | } 27 | -------------------------------------------------------------------------------- /GPBMetadata/Rpc.php: -------------------------------------------------------------------------------- 1 | internalAddGeneratedFile(hex2bin( 19 | "0a6e0a097270632e70726f746f120b4170702e53657276696365324c0a0b" . 20 | "5465737453657276696365123d0a045465737412182e4170702e4d657373" . 21 | "6167652e54657374526571756573741a192e4170702e4d6573736167652e" . 22 | "54657374526573706f6e73652200620670726f746f33" 23 | )); 24 | 25 | static::$is_initialized = true; 26 | } 27 | } 28 | 29 | -------------------------------------------------------------------------------- /GPBMetadata/Message.php: -------------------------------------------------------------------------------- 1 | internalAddGeneratedFile(hex2bin( 18 | "0a7b0a0d6d6573736167652e70726f746f120b4170702e4d657373616765" . 19 | "22350a0b5465737452657175657374120c0a046e616d6518012001280c12" . 20 | "0a0a026964180220012803120c0a04666c6167180320012808221e0a0c54" . 21 | "657374526573706f6e7365120e0a06737461747573180120012803620670" . 22 | "726f746f33" 23 | )); 24 | 25 | static::$is_initialized = true; 26 | } 27 | } 28 | 29 | -------------------------------------------------------------------------------- /tests/TestServiceClient.php: -------------------------------------------------------------------------------- 1 | _simpleRequest('/App.Service.TestService/Test', 25 | $argument, 26 | ['\App\Message\TestResponse', 'decode'], 27 | $metadata, $options); 28 | } 29 | 30 | } 31 | 32 | } 33 | -------------------------------------------------------------------------------- /App/Message/TestResponse.php: -------------------------------------------------------------------------------- 1 | App.Message.TestResponse 13 | */ 14 | class TestResponse extends \Google\Protobuf\Internal\Message 15 | { 16 | /** 17 | * int64 status = 1; 18 | */ 19 | private $status = 0; 20 | 21 | public function __construct() { 22 | \GPBMetadata\Message::initOnce(); 23 | parent::__construct(); 24 | } 25 | 26 | /** 27 | * int64 status = 1; 28 | */ 29 | public function getStatus() 30 | { 31 | return $this->status; 32 | } 33 | 34 | /** 35 | * int64 status = 1; 36 | */ 37 | public function setStatus($var) 38 | { 39 | GPBUtil::checkInt64($var); 40 | $this->status = $var; 41 | } 42 | 43 | } 44 | 45 | -------------------------------------------------------------------------------- /App/Service/TestServiceService.php: -------------------------------------------------------------------------------- 1 | decode($data); 25 | } else { 26 | $argument->mergeFromString($data); 27 | } 28 | $output = $this->Test($argument); 29 | if (method_exists($output, 'encode')) { 30 | return $output->encode(); 31 | } else if(method_exists($output, 'serializeToString')){ 32 | return $output->serializeToString(); 33 | } 34 | return ''; 35 | } 36 | 37 | } 38 | 39 | } 40 | -------------------------------------------------------------------------------- /App/Service/TestService.php: -------------------------------------------------------------------------------- 1 | . 18 | ******************************************************************************* 19 | * Author: Lidanyang 20 | ******************************************************************************/ 21 | 22 | namespace App\Service; 23 | 24 | use App\Message\TestRequest; 25 | use App\Message\TestResponse; 26 | 27 | class TestService extends TestServiceService 28 | { 29 | /** 30 | * @param TestRequest $argument input argument 31 | * @return \App\Message\TestResponse output argument 32 | **/ 33 | protected function Test(TestRequest $argument) 34 | { 35 | var_dump($argument->getName()); 36 | $response = new TestResponse(); 37 | $response->setStatus(200); 38 | return $response; 39 | } 40 | } -------------------------------------------------------------------------------- /tests/testClient.php: -------------------------------------------------------------------------------- 1 | . 17 | ******************************************************************************* 18 | * Author: Lidanyang 19 | ******************************************************************************/ 20 | 21 | require_once __DIR__ . "/vendor/autoload.php"; 22 | require_once __DIR__ . "/../vendor/autoload.php"; 23 | 24 | require_once __DIR__ . "/TestServiceClient.php"; 25 | 26 | $client = new \App\Service\TestServiceClient("0.0.0.0:9501", [ 27 | 'credentials' => \Grpc\ChannelCredentials::createInsecure(), 28 | ]); 29 | 30 | $request = new \App\Message\TestRequest(); 31 | $request->setName("Name"); 32 | $request->setId(1); 33 | $request->setFlag(true); 34 | 35 | list($reply, $status) = $client->Test($request)->wait(); 36 | var_dump($reply); 37 | var_dump($reply->getStatus()); -------------------------------------------------------------------------------- /config/debug/config.php: -------------------------------------------------------------------------------- 1 | . 17 | ******************************************************************************* 18 | * Author: Lidanyang 19 | ******************************************************************************/ 20 | 21 | 22 | return [ 23 | 'project' => [ 24 | 'project_name' => 'swoole-grpc', 25 | 'pid_path' => dirname(dirname(__DIR__)), 26 | 27 | 'main_server' => '\\grpc\\server\\MainServer', 28 | ], 29 | 30 | 'server' => [ 31 | 'host' => '0.0.0.0', 32 | 'port' => '9501', 33 | 'socket_type' => 'http2', 34 | 'enable_ssl' => false, 35 | 36 | 'setting' => [ 37 | 'worker_num' => 1, 38 | 'dispatch_mode' => 2, 39 | 40 | 'daemonize' => 0, 41 | ] 42 | ] 43 | ]; -------------------------------------------------------------------------------- /App/Message/TestRequest.php: -------------------------------------------------------------------------------- 1 | App.Message.TestRequest 13 | */ 14 | class TestRequest extends \Google\Protobuf\Internal\Message 15 | { 16 | /** 17 | * bytes name = 1; 18 | */ 19 | private $name = ''; 20 | /** 21 | * int64 id = 2; 22 | */ 23 | private $id = 0; 24 | /** 25 | * bool flag = 3; 26 | */ 27 | private $flag = false; 28 | 29 | public function __construct() { 30 | \GPBMetadata\Message::initOnce(); 31 | parent::__construct(); 32 | } 33 | 34 | /** 35 | * bytes name = 1; 36 | */ 37 | public function getName() 38 | { 39 | return $this->name; 40 | } 41 | 42 | /** 43 | * bytes name = 1; 44 | */ 45 | public function setName($var) 46 | { 47 | GPBUtil::checkString($var, False); 48 | $this->name = $var; 49 | } 50 | 51 | /** 52 | * int64 id = 2; 53 | */ 54 | public function getId() 55 | { 56 | return $this->id; 57 | } 58 | 59 | /** 60 | * int64 id = 2; 61 | */ 62 | public function setId($var) 63 | { 64 | GPBUtil::checkInt64($var); 65 | $this->id = $var; 66 | } 67 | 68 | /** 69 | * bool flag = 3; 70 | */ 71 | public function getFlag() 72 | { 73 | return $this->flag; 74 | } 75 | 76 | /** 77 | * bool flag = 3; 78 | */ 79 | public function setFlag($var) 80 | { 81 | GPBUtil::checkBool($var); 82 | $this->flag = $var; 83 | } 84 | 85 | } 86 | 87 | -------------------------------------------------------------------------------- /grpc/Entrance.php: -------------------------------------------------------------------------------- 1 | . 17 | ******************************************************************************* 18 | * Author: Lidanyang 19 | ******************************************************************************/ 20 | 21 | namespace grpc; 22 | 23 | use core\component\config\Config; 24 | use core\server\IServer; 25 | use core\server\SwooleServer; 26 | 27 | class Entrance 28 | { 29 | public static function run() 30 | { 31 | $server = new SwooleServer(Config::get('server')); 32 | 33 | $main_server_class = Config::getField('project', 'main_server'); 34 | if(!class_exists($main_server_class)) 35 | { 36 | throw new \Exception("No class {$main_server_class}"); 37 | } 38 | $main_server = new $main_server_class( 39 | Config::getField('project', 'project_name'), 40 | Config::getField('project', 'pid_path') 41 | ); 42 | if(!($main_server instanceof IServer)) 43 | { 44 | throw new \Exception("{$main_server_class} is not IServer"); 45 | } 46 | $server->run($main_server); 47 | } 48 | } -------------------------------------------------------------------------------- /grpc_generator/php_generator.h: -------------------------------------------------------------------------------- 1 | /* 2 | * 3 | * Copyright 2016, Google Inc. 4 | * All rights reserved. 5 | * 6 | * Redistribution and use in source and binary forms, with or without 7 | * modification, are permitted provided that the following conditions are 8 | * met: 9 | * 10 | * * Redistributions of source code must retain the above copyright 11 | * notice, this list of conditions and the following disclaimer. 12 | * * Redistributions in binary form must reproduce the above 13 | * copyright notice, this list of conditions and the following disclaimer 14 | * in the documentation and/or other materials provided with the 15 | * distribution. 16 | * * Neither the name of Google Inc. nor the names of its 17 | * contributors may be used to endorse or promote products derived from 18 | * this software without specific prior written permission. 19 | * 20 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 21 | * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 22 | * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 23 | * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 24 | * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 25 | * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 26 | * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 27 | * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 28 | * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 29 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 30 | * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 31 | * 32 | */ 33 | 34 | #ifndef GRPC_INTERNAL_COMPILER_PHP_GENERATOR_H 35 | #define GRPC_INTERNAL_COMPILER_PHP_GENERATOR_H 36 | 37 | #include "src/compiler/config.h" 38 | 39 | namespace grpc_php_generator { 40 | 41 | grpc::string GenerateFile(const grpc::protobuf::FileDescriptor *file, 42 | const grpc::protobuf::ServiceDescriptor *service); 43 | 44 | grpc::string GenerateServer(const grpc::protobuf::FileDescriptor *file, 45 | const grpc::protobuf::ServiceDescriptor *service); 46 | 47 | } // namespace grpc_php_generator 48 | #endif // GRPC_INTERNAL_COMPILER_PHP_GENERATOR_H 49 | -------------------------------------------------------------------------------- /run.php: -------------------------------------------------------------------------------- 1 | . 17 | ******************************************************************************* 18 | * Author: Lidanyang 19 | ******************************************************************************/ 20 | 21 | require_once __DIR__ . "/vendor/autoload.php"; 22 | 23 | use grpc\Entrance; 24 | 25 | function usage() 26 | { 27 | echo "php run.php start | restart | stop | reload [-c config_path]\n"; 28 | } 29 | 30 | if( !isset($argv[1]) ) 31 | { 32 | usage(); 33 | exit; 34 | } 35 | 36 | $cmd = $argv[1]; 37 | 38 | if( isset($argv[2]) && $argv[2] == '-c' ) { 39 | $debug = $argv[3]; 40 | } else { 41 | $debug = "debug"; 42 | } 43 | 44 | \core\component\config\Config::load(__DIR__ . "/config/{$debug}/"); 45 | 46 | $config = \core\component\config\Config::get('project'); 47 | 48 | $pid_path = $config['pid_path'] . '/' . $config['project_name'] . '_master.pid'; 49 | $manager_pid_path = $config['pid_path'] . '/' . $config['project_name'] . '_manager.pid'; 50 | 51 | switch($cmd) 52 | { 53 | case 'start': 54 | { 55 | 56 | Entrance::run(); 57 | break; 58 | } 59 | case 'restart': 60 | { 61 | 62 | shell_exec("kill -15 `cat {$manager_pid_path}`"); 63 | shell_exec("kill -15 `cat {$pid_path}`"); 64 | echo "restarting...\n"; 65 | sleep(3); 66 | 67 | Entrance::run(); 68 | break; 69 | } 70 | case 'stop': 71 | { 72 | shell_exec("kill -15 `cat {$manager_pid_path}`"); 73 | shell_exec("kill -15 `cat {$pid_path}`"); 74 | break; 75 | } 76 | case 'reload': 77 | { 78 | shell_exec("kill -USR1 `cat {$manager_pid_path}`"); 79 | shell_exec("kill -USR1 `cat {$pid_path}`"); 80 | break; 81 | } 82 | } 83 | -------------------------------------------------------------------------------- /grpc_generator/php_generator_helpers.h: -------------------------------------------------------------------------------- 1 | /* 2 | * 3 | * Copyright 2016, Google Inc. 4 | * All rights reserved. 5 | * 6 | * Redistribution and use in source and binary forms, with or without 7 | * modification, are permitted provided that the following conditions are 8 | * met: 9 | * 10 | * * Redistributions of source code must retain the above copyright 11 | * notice, this list of conditions and the following disclaimer. 12 | * * Redistributions in binary form must reproduce the above 13 | * copyright notice, this list of conditions and the following disclaimer 14 | * in the documentation and/or other materials provided with the 15 | * distribution. 16 | * * Neither the name of Google Inc. nor the names of its 17 | * contributors may be used to endorse or promote products derived from 18 | * this software without specific prior written permission. 19 | * 20 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 21 | * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 22 | * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 23 | * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 24 | * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 25 | * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 26 | * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 27 | * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 28 | * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 29 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 30 | * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 31 | * 32 | */ 33 | 34 | #ifndef GRPC_INTERNAL_COMPILER_PHP_GENERATOR_HELPERS_H 35 | #define GRPC_INTERNAL_COMPILER_PHP_GENERATOR_HELPERS_H 36 | 37 | #include 38 | 39 | #include "src/compiler/config.h" 40 | #include "src/compiler/generator_helpers.h" 41 | 42 | namespace grpc_php_generator { 43 | 44 | inline grpc::string GetPHPServiceFilename( 45 | const grpc::protobuf::FileDescriptor *file, 46 | const grpc::protobuf::ServiceDescriptor *service) { 47 | std::vector tokens = 48 | grpc_generator::tokenize(file->package(), "."); 49 | std::ostringstream oss; 50 | for (unsigned int i = 0; i < tokens.size(); i++) { 51 | oss << (i == 0 ? "" : "/") 52 | << grpc_generator::CapitalizeFirstLetter(tokens[i]); 53 | } 54 | return oss.str() + "/" + service->name() + "Client.php"; 55 | } 56 | 57 | inline grpc::string GetPHPServerFilename( 58 | const grpc::protobuf::FileDescriptor *file, 59 | const grpc::protobuf::ServiceDescriptor *service) { 60 | std::vector tokens = 61 | grpc_generator::tokenize(file->package(), "."); 62 | std::ostringstream oss; 63 | for (unsigned int i = 0; i < tokens.size(); i++) { 64 | oss << (i == 0 ? "" : "/") 65 | << grpc_generator::CapitalizeFirstLetter(tokens[i]); 66 | } 67 | return oss.str() + "/" + service->name() + "Service.php"; 68 | } 69 | 70 | // Get leading or trailing comments in a string. Comment lines start with "// ". 71 | // Leading detached comments are put in in front of leading comments. 72 | template 73 | inline grpc::string GetPHPComments(const DescriptorType *desc, 74 | grpc::string prefix) { 75 | return grpc_generator::GetPrefixedComments(desc, true, prefix); 76 | } 77 | 78 | } // namespace grpc_php_generator 79 | 80 | #endif // GRPC_INTERNAL_COMPILER_PHP_GENERATOR_HELPERS_H 81 | -------------------------------------------------------------------------------- /grpc_generator/php_plugin.cc: -------------------------------------------------------------------------------- 1 | /* 2 | * 3 | * Copyright 2016, Google Inc. 4 | * All rights reserved. 5 | * 6 | * Redistribution and use in source and binary forms, with or without 7 | * modification, are permitted provided that the following conditions are 8 | * met: 9 | * 10 | * * Redistributions of source code must retain the above copyright 11 | * notice, this list of conditions and the following disclaimer. 12 | * * Redistributions in binary form must reproduce the above 13 | * copyright notice, this list of conditions and the following disclaimer 14 | * in the documentation and/or other materials provided with the 15 | * distribution. 16 | * * Neither the name of Google Inc. nor the names of its 17 | * contributors may be used to endorse or promote products derived from 18 | * this software without specific prior written permission. 19 | * 20 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 21 | * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 22 | * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 23 | * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 24 | * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 25 | * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 26 | * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 27 | * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 28 | * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 29 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 30 | * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 31 | * 32 | */ 33 | 34 | // Generates PHP gRPC service interface out of Protobuf IDL. 35 | 36 | #include 37 | 38 | #include "src/compiler/config.h" 39 | #include "src/compiler/php_generator.h" 40 | #include "src/compiler/php_generator_helpers.h" 41 | 42 | using grpc_php_generator::GenerateFile; 43 | using grpc_php_generator::GetPHPServiceFilename; 44 | using grpc_php_generator::GetPHPServerFilename; 45 | using grpc_php_generator::GenerateServer; 46 | 47 | class PHPGrpcGenerator : public grpc::protobuf::compiler::CodeGenerator { 48 | public: 49 | PHPGrpcGenerator() {} 50 | ~PHPGrpcGenerator() {} 51 | 52 | bool Generate(const grpc::protobuf::FileDescriptor *file, 53 | const grpc::string ¶meter, 54 | grpc::protobuf::compiler::GeneratorContext *context, 55 | grpc::string *error) const { 56 | if (file->service_count() == 0) { 57 | return true; 58 | } 59 | 60 | for (int i = 0; i < file->service_count(); i++) { 61 | grpc::string code = GenerateFile(file, file->service(i)); 62 | 63 | // Get output file name 64 | grpc::string file_name = GetPHPServiceFilename(file, file->service(i)); 65 | 66 | std::unique_ptr output( 67 | context->Open(file_name)); 68 | grpc::protobuf::io::CodedOutputStream coded_out(output.get()); 69 | coded_out.WriteRaw(code.data(), code.size()); 70 | } 71 | 72 | for (int i = 0; i < file->service_count(); i++) { 73 | grpc::string code = GenerateServer(file, file->service(i)); 74 | 75 | // Get output file name 76 | grpc::string file_name = GetPHPServerFilename(file, file->service(i)); 77 | 78 | std::unique_ptr output( 79 | context->Open(file_name)); 80 | grpc::protobuf::io::CodedOutputStream coded_out(output.get()); 81 | coded_out.WriteRaw(code.data(), code.size()); 82 | } 83 | 84 | return true; 85 | } 86 | }; 87 | 88 | int main(int argc, char *argv[]) { 89 | PHPGrpcGenerator generator; 90 | return grpc::protobuf::compiler::PluginMain(argc, argv, &generator); 91 | } 92 | -------------------------------------------------------------------------------- /grpc/server/MainServer.php: -------------------------------------------------------------------------------- 1 | . 17 | ******************************************************************************* 18 | * Author: Lidanyang 19 | ******************************************************************************/ 20 | 21 | namespace grpc\server; 22 | 23 | use core\common\Globals; 24 | use core\component\log\Log; 25 | use core\server\adapter\HttpServer; 26 | 27 | class MainServer extends HttpServer 28 | { 29 | /** 30 | * 初始化函数，在swoole_server启动前执行 31 | * @param $server 32 | */ 33 | public function init(\swoole_server $server) 34 | { 35 | 36 | } 37 | 38 | 39 | /** 40 | * 服务器接收到Http完整数据包后回调此函数 41 | * @param \swoole_http_request $request swoole封装的http请求对象 42 | * @param \swoole_http_response $response swoole封装的http应答对象 43 | */ 44 | public function onRequest(\swoole_http_request $request, \swoole_http_response $response) 45 | { 46 | $uri = $request->server['request_uri']; 47 | $uris = explode("/", $uri); 48 | 49 | $class = str_replace("." , '\\', $uris[1]); 50 | $method = "run" . $uris[2]; 51 | 52 | if(!class_exists($class)) 53 | { 54 | Log::ERROR("System", "$class not found"); 55 | $response->status(403); 56 | $response->end(); 57 | return; 58 | } 59 | 60 | $rawContent = $data = substr($request->rawContent(), 5); 61 | 62 | try { 63 | $service = new $class(); 64 | 65 | $result = $service->$method($rawContent); 66 | 67 | $data = pack('CN', 0, strlen($result)) . $result; 68 | $response->end($data); 69 | } catch (\Exception $e) { 70 | Log::ERROR("System", $e->getMessage()); 71 | $response->status(500); 72 | $response->end($e->getMessage()); 73 | } catch (\Error $e) { 74 | Log::ERROR("System", $e->getMessage()); 75 | $response->status(500); 76 | $response->end($e->getMessage()); 77 | } 78 | } 79 | 80 | 81 | /** 82 | * Worker进程启动前回调此函数 83 | * @param \swoole_server $server swoole_server对象 84 | * @param int $workerId Worker进程ID 85 | */ 86 | public function onWorkerStart(\swoole_server $server, $workerId) 87 | { 88 | Globals::$server = $server; 89 | } 90 | 91 | /** 92 | * 当Worker进程投递任务到Task Worker进程时调用此函数 93 | * @param \swoole_server $server swoole_server对象 94 | * @param int $task_id 任务ID 95 | * @param int $src_worker_id 发起任务的Worker进程ID 96 | * @param mixed $data 任务数据 97 | */ 98 | public function onTask(\swoole_server $server, $task_id, $src_worker_id, $data) 99 | { 100 | // TODO: Implement onTask() method. 101 | } 102 | 103 | /** 104 | * Swoole进程间通信的回调函数 105 | * @param \swoole_server $server swoole_server对象 106 | * @param int $from_worker_id 来源Worker进程ID 107 | * @param mixed $message 消息内容 108 | */ 109 | public function onPipeMessage(\swoole_server $server, $from_worker_id, $message) 110 | { 111 | // TODO: Implement onPipeMessage() method. 112 | } 113 | } -------------------------------------------------------------------------------- /grpc_generator/php_generator.cc: -------------------------------------------------------------------------------- 1 | /* 2 | * 3 | * Copyright 2016, Google Inc. 4 | * All rights reserved. 5 | * 6 | * Redistribution and use in source and binary forms, with or without 7 | * modification, are permitted provided that the following conditions are 8 | * met: 9 | * 10 | * * Redistributions of source code must retain the above copyright 11 | * notice, this list of conditions and the following disclaimer. 12 | * * Redistributions in binary form must reproduce the above 13 | * copyright notice, this list of conditions and the following disclaimer 14 | * in the documentation and/or other materials provided with the 15 | * distribution. 16 | * * Neither the name of Google Inc. nor the names of its 17 | * contributors may be used to endorse or promote products derived from 18 | * this software without specific prior written permission. 19 | * 20 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 21 | * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 22 | * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 23 | * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 24 | * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 25 | * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 26 | * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 27 | * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 28 | * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 29 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 30 | * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 31 | * 32 | */ 33 | 34 | #include 35 | 36 | #include "src/compiler/config.h" 37 | #include "src/compiler/generator_helpers.h" 38 | #include "src/compiler/php_generator_helpers.h" 39 | 40 | using grpc::protobuf::FileDescriptor; 41 | using grpc::protobuf::ServiceDescriptor; 42 | using grpc::protobuf::MethodDescriptor; 43 | using grpc::protobuf::Descriptor; 44 | using grpc::protobuf::io::Printer; 45 | using grpc::protobuf::io::StringOutputStream; 46 | using std::map; 47 | 48 | namespace grpc_php_generator { 49 | namespace { 50 | 51 | grpc::string MessageIdentifierName(const grpc::string &name) { 52 | std::vector tokens = grpc_generator::tokenize(name, "."); 53 | std::ostringstream oss; 54 | for (unsigned int i = 0; i < tokens.size(); i++) { 55 | oss << (i == 0 ? "" : "\\") 56 | << grpc_generator::CapitalizeFirstLetter(tokens[i]); 57 | } 58 | return oss.str(); 59 | } 60 | 61 | void PrintMethod(const MethodDescriptor *method, Printer *out) { 62 | const Descriptor *input_type = method->input_type(); 63 | const Descriptor *output_type = method->output_type(); 64 | map vars; 65 | vars["service_name"] = method->service()->full_name(); 66 | vars["name"] = method->name(); 67 | vars["input_type_id"] = MessageIdentifierName(input_type->full_name()); 68 | vars["output_type_id"] = MessageIdentifierName(output_type->full_name()); 69 | 70 | out->Print("/**\n"); 71 | out->Print(GetPHPComments(method, " *").c_str()); 72 | if (method->client_streaming()) { 73 | out->Print(vars, 74 | " * @param array $$metadata metadata\n" 75 | " * @param array $$options call options\n */\n" 76 | "public function $name$($$metadata = [], " 77 | "$$options = []) {\n"); 78 | out->Indent(); 79 | if (method->server_streaming()) { 80 | out->Print("return $$this->_bidiRequest("); 81 | } else { 82 | out->Print("return $$this->_clientStreamRequest("); 83 | } 84 | out->Print(vars, 85 | "'/$service_name$/$name$',\n" 86 | "['\\$output_type_id$','decode'],\n" 87 | "$$metadata, $$options);\n"); 88 | } else { 89 | out->Print(vars, 90 | " * @param \\$input_type_id$ $$argument input argument\n" 91 | " * @param array $$metadata metadata\n" 92 | " * @param array $$options call options\n */\n" 93 | "public function $name$(\\$input_type_id$ $$argument,\n" 94 | " $$metadata = [], $$options = []) {\n"); 95 | out->Indent(); 96 | if (method->server_streaming()) { 97 | out->Print("return $$this->_serverStreamRequest("); 98 | } else { 99 | out->Print("return $$this->_simpleRequest("); 100 | } 101 | out->Print(vars, 102 | "'/$service_name$/$name$',\n" 103 | "$$argument,\n" 104 | "['\\$output_type_id$', 'decode'],\n" 105 | "$$metadata, $$options);\n"); 106 | } 107 | out->Outdent(); 108 | out->Print("}\n\n"); 109 | } 110 | 111 | void PrintServerMethod(const MethodDescriptor *method, Printer *out) { 112 | const Descriptor *input_type = method->input_type(); 113 | const Descriptor *output_type = method->output_type(); 114 | map vars; 115 | vars["service_name"] = method->service()->full_name(); 116 | vars["name"] = method->name(); 117 | vars["input_type_id"] = MessageIdentifierName(input_type->full_name()); 118 | vars["output_type_id"] = MessageIdentifierName(output_type->full_name()); 119 | 120 | out->Print("/**\n"); 121 | out->Print(GetPHPComments(method, " *").c_str()); 122 | out->Print(vars, 123 | " * @param \\$input_type_id$ $$argument input argument\n" 124 | " * @return \\$output_type_id$ output argument\n" 125 | " **/\n" 126 | "abstract protected function $name$(\\$input_type_id$ $$argument);\n\n" 127 | ); 128 | out->Print("/**\n"); 129 | out->Print(GetPHPComments(method, " *").c_str()); 130 | out->Print(vars, 131 | " * @param \\mixed $$data input data\n" 132 | " * @return \\string output data\n" 133 | " **/\n" 134 | "public function run$name$($$data) {\n" 135 | ); 136 | out->Indent(); 137 | out->Print(vars, 138 | "$$argument = new \\$input_type_id$();\n" 139 | "if (method_exists($$argument, 'decode')) {\n" 140 | ); 141 | 142 | out->Indent(); 143 | out->Print("$$argument->decode($$data);\n"); 144 | out->Outdent(); 145 | out->Print("} else {\n"); 146 | out->Indent(); 147 | out->Print("$$argument->mergeFromString($$data);\n"); 148 | out->Outdent(); 149 | out->Print("}\n"); 150 | 151 | out->Print(vars, 152 | "$$output = $$this->$name$($$argument);\n" 153 | "if (method_exists($$output, 'encode')) {\n"); 154 | out->Indent(); 155 | out->Print("return $$output->encode();\n"); 156 | out->Outdent(); 157 | out->Print("} else if(method_exists($$output, 'serializeToString')){\n"); 158 | out->Indent(); 159 | out->Print("return $$output->serializeToString();\n"); 160 | out->Outdent(); 161 | out->Print("}\n"); 162 | out->Print("return '';\n"); 163 | out->Outdent(); 164 | out->Print("}\n\n"); 165 | } 166 | 167 | // Prints out the service descriptor object 168 | void PrintService(const ServiceDescriptor *service, Printer *out) { 169 | map vars; 170 | out->Print(GetPHPComments(service, "//").c_str()); 171 | vars["name"] = service->name(); 172 | out->Print(vars, "class $name$Client extends \\Grpc\\BaseStub {\n\n"); 173 | out->Indent(); 174 | out->Print( 175 | "/**\n * @param string $$hostname hostname\n" 176 | " * @param array $$opts channel options\n" 177 | " * @param \\Grpc\\Channel $$channel (optional) re-use channel " 178 | "object\n */\n" 179 | "public function __construct($$hostname, $$opts, " 180 | "$$channel = null) {\n"); 181 | out->Indent(); 182 | out->Print("parent::__construct($$hostname, $$opts, $$channel);\n"); 183 | out->Outdent(); 184 | out->Print("}\n\n"); 185 | for (int i = 0; i < service->method_count(); i++) { 186 | grpc::string method_name = 187 | grpc_generator::LowercaseFirstLetter(service->method(i)->name()); 188 | PrintMethod(service->method(i), out); 189 | } 190 | out->Outdent(); 191 | out->Print("}\n\n"); 192 | } 193 | 194 | void PrintServerService(const ServiceDescriptor *service, Printer *out) { 195 | map vars; 196 | out->Print(GetPHPComments(service, "//").c_str()); 197 | vars["name"] = service->name(); 198 | out->Print(vars, "abstract class $name$Service {\n\n"); 199 | out->Indent(); 200 | out->Print( 201 | "public function __construct() {\n"); 202 | out->Indent(); 203 | out->Outdent(); 204 | out->Print("}\n\n"); 205 | for (int i = 0; i < service->method_count(); i++) { 206 | grpc::string method_name = 207 | grpc_generator::LowercaseFirstLetter(service->method(i)->name()); 208 | PrintServerMethod(service->method(i), out); 209 | } 210 | out->Outdent(); 211 | out->Print("}\n\n"); 212 | } 213 | 214 | } 215 | 216 | grpc::string GenerateFile(const FileDescriptor *file, 217 | const ServiceDescriptor *service) { 218 | grpc::string output; 219 | { 220 | StringOutputStream output_stream(&output); 221 | Printer out(&output_stream, '$'); 222 | 223 | out.Print(" vars; 233 | vars["package"] = MessageIdentifierName(file->package()); 234 | out.Print(vars, "namespace $package$ {\n\n"); 235 | out.Indent(); 236 | 237 | PrintService(service, &out); 238 | 239 | out.Outdent(); 240 | out.Print("}\n"); 241 | } 242 | return output; 243 | } 244 | 245 | grpc::string GenerateServer(const FileDescriptor *file, 246 | const ServiceDescriptor *service) { 247 | grpc::string output; 248 | { 249 | StringOutputStream output_stream(&output); 250 | Printer out(&output_stream, '$'); 251 | 252 | out.Print(" vars; 262 | vars["package"] = MessageIdentifierName(file->package()); 263 | out.Print(vars, "namespace $package$ {\n\n"); 264 | out.Indent(); 265 | 266 | PrintServerService(service, &out); 267 | 268 | out.Outdent(); 269 | out.Print("}\n"); 270 | } 271 | return output; 272 | } 273 | 274 | 275 | } // namespace grpc_php_generator 276 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | {project} Copyright (C) {year} {fullname} 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------