diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..f9cd27f --- /dev/null +++ b/.gitignore @@ -0,0 +1,12 @@ +.buildpath +.settings/ +.project +*.patch +.idea/ +.git/ +.phpintel/ +runtime/ +vendor/ +*.lock +.DS_Store +*.cache diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md new file mode 100644 index 0000000..97604ab --- /dev/null +++ b/README.md @@ -0,0 +1,15 @@ +# Swlib + +Some swoole helpr utils for swoft + +## Install + +- install by composer + +```bash +composer require swoft/swlib +``` + +## LICENSE + +The Component is open-sourced software licensed under the [Apache license](LICENSE). diff --git a/composer.json b/composer.json new file mode 100644 index 0000000..47ad275 --- /dev/null +++ b/composer.json @@ -0,0 +1,31 @@ +{ + "name": "swoft/swlib", + "type": "library", + "keywords": [ + "swoole", + "swoft", + "swoft-component" + ], + "description": "Some swoole helpr utils for swoft", + "license": "Apache-2.0", + "require": { + "php": ">7.1" + }, + "autoload": { + "psr-4": { + "Swoft\\Swlib\\": "src/" + } + }, + "require-dev": { + "phpunit/phpunit": "^7.5" + }, + "autoload-dev": { + "psr-4": { + "SwoftTest\\Swlib\\Unit\\": "test/unit/", + "SwoftTest\\Swlib\\Testing\\": "test/testing/" + } + }, + "scripts": { + "test": "./vendor/bin/phpunit -c phpunit.xml" + } +} diff --git a/src/AutoLoader.php b/src/AutoLoader.php new file mode 100644 index 0000000..78b0bb3 --- /dev/null +++ b/src/AutoLoader.php @@ -0,0 +1,41 @@ + dir path + * ] + */ + public function getPrefixDirs(): array + { + return [ + __NAMESPACE__ => __DIR__, + ]; + } + + /** + * Metadata information for the component. + * + * @return array + * @see ComponentInterface::getMetadata() + */ + public function metadata(): array + { + $jsonFile = dirname(__DIR__) . '/composer.json'; + + return ComposerJSON::open($jsonFile)->getMetadata(); + } +} diff --git a/src/HttpClient.php b/src/HttpClient.php new file mode 100644 index 0000000..9698b0e --- /dev/null +++ b/src/HttpClient.php @@ -0,0 +1,308 @@ + 'http', + 'host' => 'localhost', + 'port' => '80', + 'user' => '', + 'pass' => '', + 'path' => '/', + 'query' => '', + 'fragment' => '', + ]; + + /** + * @var array + */ + private $options = []; + + /** + * @var string + */ + private $fullUrl = ''; + + /** + * @var array + */ + private $rawResult = [ + 'errCode' => 0, + 'errMsg' => 0, + 'status' => 200, + ]; + + /** + * Send GET request + * + * @param string $url + * @param array $options + * + * @return Response + */ + public function get(string $url, array $options = []): Response + { + return $this->request('GET', $url, $options); + } + + /** + * Send POST request + * + * @param string $url + * @param mixed $data + * @param array $options + * + * @return Response + */ + public function post(string $url, $data, array $options = []): Response + { + $options['data'] = $data; + + return $this->request('POST', $url, $options); + } + + /** + * Send JSON request + * + * @param string $url + * @param array $data + * @param array $options + * + * @return Response + */ + public function json(string $url, array $data, array $options = []): Response + { + $options['json'] = $data; + + return $this->request('POST', $url, $options); + } + + /** + * @param string $method + * @param string $url + * @param array $options + * + * @return Response + */ + public function request(string $method, string $url, array $options = []): Response + { + if (!isset($options['method'])) { + $options['method'] = $method; + } + + $info = $this->parseUrl($url); + $port = (int)$info['port']; + $client = new Client($info['host'], $port, $port === 443); + + // config request + $uriPath = $this->configRequest($client, $info, $options); + + $client->execute($uriPath); + + $this->fullUrl = $info['scheme'] . '://' . $info['host'] . $uriPath; + $this->rawResult = [ + 'errCode' => $client->errCode, + 'errMsg' => $client->errMsg, + 'status' => $client->statusCode, + ]; + + // trans to psr7 response + $resp = new Response(); + $resp = $resp->withContent($client->body)->withStatus($client->statusCode); + + // close connection + $client->close(); + + return $resp; + } + + /** + * @param Client $client + * @param array $info + * @param array $options + * + * @return string + */ + private function configRequest(Client $client, array $info, array $options): string + { + if ($this->options) { + $options = array_merge($this->options, $options); + } + + $uriPath = $info['path'] . ($info['query'] ? '?' . $info['query'] : ''); + $method = $options['method'] ?: 'GET'; + $headers = $options['headers'] ?? []; + $sendData = $options['data'] ?? null; + + // set request method + $client->setMethod($method = strtoupper($method)); + + // allow send data(POST, PUT, PATCH) + if (in_array($method, ['POST', 'PUT', 'PATCH'], true)) { + $postData = ''; + if ($jsonMap = $options['json'] ?? []) { + $postData = json_encode($jsonMap); + + // add content type + $headers['Content-Type'] = ContentType::JSON; + } elseif ($formMap = $options['form'] ?? []) { + $postData = http_build_query($formMap); + + // add content type + $headers['Content-Type'] = ContentType::FORM; + } elseif ($sendData) { + if (is_array($sendData)) { + $postData = http_build_query($sendData); + + // add content type + $headers['Content-Type'] = ContentType::FORM; + } else { + $postData = (string)$sendData; + } + } + + // has post data + if ($postData) { + $client->setData($postData); + } + } elseif ($sendData) { + $queryStr = $this->buildQuery($sendData); + $uriPath = $this->appendQueryString($uriPath, $queryStr); + } + + // has query data + if ($queryMap = $options['query'] ?? 0) { + $queryStr = $this->buildQuery($queryMap); + $uriPath = $this->appendQueryString($uriPath, $queryStr); + } + + /* + * [key => value] + */ + if ($headers) { + $client->setHeaders($headers); + } + + /* + * [key => value] + */ + if ($cookies = $options['cookies'] ?? []) { + $client->setCookies($cookies); + } + + /** + * [ + * timeout => 3 // 3 seconds + * keep_alive => true + * websocket_mask => true + * ] + * + * more @see https://wiki.swoole.com/wiki/page/p-client_setting.html + */ + if ($settings = $options['settings'] ?? []) { + $client->set($settings); + } + + return $uriPath; + } + + /** + * @param string $uriPath + * @param string $queryString + * + * @return string + */ + private function appendQueryString(string $uriPath, string $queryString): string + { + // check sep char + $sepChar = strpos($uriPath, '?') > 0 ? '&' : '?'; + + return $uriPath . $sepChar . $queryString; + } + + /** + * @param string $url + * + * @return array + */ + public function parseUrl(string $url): array + { + $info = array_merge(self::DEFAULT_URL_DATA, parse_url($url)); + + if ($info['scheme'] === 'https') { + $info['port'] = 443; + } + + return $info; + } + + /** + * @param array|string $queryData + * + * @return string + */ + public function buildQuery($queryData): string + { + // is string + if (is_string($queryData)) { + return $queryData; + } + + // array: k-v map + return preg_replace('/%5B(?:\d|[1-9]\d+)%5D=/', '=', http_build_query($queryData)); + } + + /** + * @return string + */ + public function getFullUrl(): string + { + return $this->fullUrl; + } + + /** + * @return array + */ + public function getRawResult(): array + { + return $this->rawResult; + } + + /** + * @param array $options + * + * @return HttpClient + */ + public function setOptions(array $options): self + { + $this->options = $options; + return $this; + } +} diff --git a/src/MemTable.php b/src/MemTable.php new file mode 100644 index 0000000..d44c9a5 --- /dev/null +++ b/src/MemTable.php @@ -0,0 +1,428 @@ + ['type', 'size'] + * ] + * + * @var array $column + */ + private $columns = []; + + /** + * Is memory table created ? + * + * @var bool + */ + private $created = false; + + /** + * @var string + */ + private $dbFile = ''; + + /** + * Table constructor. + * + * @param string $name + * @param int $size + * @param array $columns ['field' => ['type', 'size']] + * + * @throws InvalidArgumentException + */ + public function __construct(string $name = '', int $size = 0, array $columns = []) + { + $this->setName($name); + $this->setSize($size); + $this->setColumns($columns); + } + + /** + * Set memory table columns + * + * @param array $columns + * + * @throws InvalidArgumentException + */ + public function setColumns(array $columns): void + { + foreach ($columns as $column => [$type, $size]) { + $this->columns[$column] = [(int)$type, (int)$size]; + } + } + + /** + * Add a column + * + * @param string $name Column name + * @param int $type Column type. {@see Table::TYPE_INT, Table::TYPE_FLOAT, Table::TYPE_STRING} + * @param int $size Max length of column (in bits) + * + * @return self + */ + public function addColumn(string $name, int $type, int $size = 0): self + { + $this->columns[$name] = [$type, $size]; + + return $this; + } + + /** + * Create table by columns + * + * @return bool + * @throws RuntimeException + * @throws InvalidArgumentException + */ + public function create(): bool + { + if ($this->isCreate()) { + throw new RuntimeException('Memory table have been created, cannot recreated'); + } + + // Create memory table instance + $table = new Table($this->getSize()); + $this->setTable($table); + + // Set columns + foreach ($this->columns as $name => [$type, $size]) { + $this->table->column($name, $type, $size); + } + + // Create memory table + $result = $table->create(); + + // Change memory table create status + $this->created = true; + return $result; + } + + /***************************************************************************** + * Operate data methods + ****************************************************************************/ + + /** + * Set data by key + * + * @param string $key Index key + * @param array $data + * + * @return bool + * @throws RuntimeException + */ + public function set(string $key, array $data): bool + { + if (!$this->isCreate()) { + throw new RuntimeException('Memory table have not been create'); + } + + return $this->getTable()->set($key, $data); + } + + /** + * Get data by key and field + * + * @param string $key Index key + * @param string $field Filed name of Index + * + * @return array|false Will return an array when success, return false when failure + * @throws RuntimeException + */ + public function get(string $key, string $field = null) + { + return $this->getTable()->get($key, $field); + } + + /** + * Determine if column exist + * + * @param string $key Index key + * + * @return bool + * @throws RuntimeException + */ + public function exist(string $key): bool + { + return $this->getTable()->exist($key); + } + + /** + * Delete data by index key + * + * @param string $key Index key + * + * @return bool + * @throws RuntimeException + */ + public function del(string $key): bool + { + return $this->getTable()->del($key); + } + + /** + * Increase + * + * @param string $key Index key + * @param string $field Field of Index + * @param int|float $incrby Increase value, the value type should follow the original type of column + * + * @return bool|int|float Will return false when failure, return the value after increased when success + * @throws RuntimeException + */ + public function incr(string $key, string $field, $incrby = 1) + { + return $this->getTable()->incr($key, $field, $incrby); + } + + /** + * Decrease + * + * @param string $key Index key + * @param string $field Field of Index + * @param int|float $decrBy Decrease value, the value type should follow the original type of column + * + * @return bool|int|float Will return false when failure, return the value after decreased when success + * @throws RuntimeException + */ + public function decr(string $key, string $field, $decrBy = 1) + { + return $this->getTable()->decr($key, $field, $decrBy); + } + + /** + * @return int + */ + public function count(): int + { + return count($this->table); + } + + /***************************************************************************** + * Extra methods + ****************************************************************************/ + + /** + * flush table + */ + // public function flush(): void + // { + // foreach ($this->table as $row) { + // $this->table->del($row['key']); + // } + // } + + /** + * Restore data from dbFile + * + * @param bool $coRead + */ + public function restore(bool $coRead = false): void + { + $file = $this->dbFile; + if (!$file || !file_exists($file)) { + return; + } + + if ($coRead) { + $content = Coroutine::readFile($file); + } else { + $content = file_get_contents($file); + } + + $this->load((array)json_decode($content, true)); + } + + /** + * Export memory data to dbFile + * + * @param bool $coWrite + */ + public function dump(bool $coWrite = false): void + { + if (!$file = $this->dbFile) { + return; + } + + $data = []; + foreach ($this->table as $row) { + $data[] = $row; + } + + if ($coWrite) { + Coroutine::writeFile($file, json_encode($data)); + } else { + file_put_contents($file, json_encode($data)); + } + } + + /** + * @param array $data + */ + public function load(array $data): void + { + foreach ($data as $row) { + if (isset($row['text'])) { + $this->table->set($row['text'], $row); + } + } + } + + + /***************************************************************************** + * Getter/Setter methods + ****************************************************************************/ + + /** + * Set memory table instance + * + * @param Table $table Table instance + */ + public function setTable(Table $table): void + { + $this->table = $table; + } + + /** + * Get the memory table instance + * + * @return Table + * @throws RuntimeException + */ + public function getTable(): Table + { + if (!$this->isCreated()) { + throw new RuntimeException('Memory table have not been create'); + } + + return $this->table; + } + + /** + * Set memory table name + * + * @param string $name Memory table name + */ + public function setName(string $name): void + { + $this->name = $name; + } + + /** + * Get memory table name + * + * @return string + */ + public function getName(): string + { + return $this->name; + } + + /** + * Set memory table size + * + * @param int $size + */ + public function setSize(int $size): void + { + $this->size = $size; + } + + /** + * Get memory table size that have been set + * + * @return int + */ + public function getSize(): int + { + return $this->size; + } + + /** + * Get memory table columns structure + * + * @return mixed + */ + public function getColumns() + { + return $this->columns; + } + + /** + * @return string + */ + public function getDbFile(): string + { + return $this->dbFile; + } + + /** + * @param string $dbFile + */ + public function setDbFile(string $dbFile): void + { + $this->dbFile = $dbFile; + } + + /** + * @return bool + */ + public function isCreated(): bool + { + return $this->created; + } + + /** + * @param bool $create + */ + public function setCreate(bool $create): void + { + $this->created = $create; + } +} diff --git a/test/bootstrap.php b/test/bootstrap.php new file mode 100644 index 0000000..f0e558f --- /dev/null +++ b/test/bootstrap.php @@ -0,0 +1,6 @@ +