diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml new file mode 100644 index 0000000..463ba7e --- /dev/null +++ b/.github/workflows/main.yml @@ -0,0 +1,32 @@ +name: Integrity check + +on: [push] + +jobs: + build: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@master + + - name: Install PHP + uses: shivammathur/setup-php@master + with: + php-version: 7.4 + + - name: Install composer deps + run: | + composer create-project nette/code-checker temp/code-checker ^3 --no-progress + composer create-project nette/coding-standard temp/coding-standard ^2 --no-progress + + # Install app deps + composer install --no-interaction --prefer-dist + + # Check code checker and coding standards + - name: Check coding standards + run: | + php temp/code-checker/code-checker --short-arrays --strict-types --fix --no-progress + php temp/coding-standard/ecs check src --config temp/coding-standard/coding-standard-php71.yml + + - name: Check PHPStan rules + run: composer phpstan 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..81eab18 --- /dev/null +++ b/README.md @@ -0,0 +1,65 @@ +MJML PHP server +=============== + +![Integrity check](https://github.com/baraja-core/mjml-php-server/workflows/Integrity%20check/badge.svg) + +Imagine you want render your [MJML template](https://mjml.io) on your private PHP server, now you can. + +How to install +-------------- + +Install this package by [Composer](https://getcomposer.org) or download manually: + +```shell +composer require baraja-core/mjml-php-server +``` + +Your server must use `PHP 7.1` or better and installed MJML by Node modules (internal command is `/node_modules/.bin/mjml`). + +Server configuration +-------------------- + +Your server must support the [shell_exec()](https://www.php.net/manual/en/function.shell-exec.php) function and Apache or Ngnix. + +In your root directory of webserver please configure calling this internal logic. For instance this way (most simply solution): + +```php +run(); +``` + +Now your MJML server is configured. + +When you call URI `/api/v1/mjml` by HTTP request on your domain, you can render your MJML template. + +API usage +--------- + +API must be called by POST method with body parameter `template` with template. + +Final template will be returned by json response. + +Some example: + +Call URI `/api/v1/mjml` with parameter: + +![MJML API Response example](doc/mjml-api-response.png) + +Minimal template configuration: + +```html + + + + + Hello World + + + + +``` \ No newline at end of file diff --git a/composer.json b/composer.json new file mode 100644 index 0000000..e4d27a6 --- /dev/null +++ b/composer.json @@ -0,0 +1,30 @@ +{ + "name": "baraja-core/mjml-php-server", + "description": "Render your MJML template on custom PHP server.", + "homepage": "https://github.com/baraja-core/mjml-php-server", + "authors": [ + { + "name": "Jan Barášek", + "homepage": "https://baraja.cz" + } + ], + "require": { + "php": ">=7.1.0" + }, + "require-dev": { + "phpstan/phpstan": "^0.12.18", + "tracy/tracy": "^2.7", + "phpstan/phpstan-nette": "^0.12.6" + }, + "autoload": { + "classmap": [ + "src/" + ] + }, + "scripts": { + "phpstan": [ + "vendor/bin/phpstan analyse src -c phpstan.neon --level 6 --no-progress" + ] + }, + "minimum-stability": "stable" +} diff --git a/doc/mjml-api-response.png b/doc/mjml-api-response.png new file mode 100644 index 0000000..bd9f7f6 Binary files /dev/null and b/doc/mjml-api-response.png differ diff --git a/phpstan.neon b/phpstan.neon new file mode 100644 index 0000000..a822eec --- /dev/null +++ b/phpstan.neon @@ -0,0 +1,4 @@ +includes: + - vendor/phpstan/phpstan-nette/extension.neon + - vendor/phpstan/phpstan-nette/rules.neon + diff --git a/src/MjmlServer.php b/src/MjmlServer.php new file mode 100644 index 0000000..fcc6ffd --- /dev/null +++ b/src/MjmlServer.php @@ -0,0 +1,155 @@ +cacheDir = rtrim($cacheDir ?? __DIR__ . '/../cache', '/'); + $this->createDir($this->cacheDir); + } + + + public function run(): void + { + if (isset($_SERVER['REQUEST_URI']) && $_SERVER['REQUEST_URI'] === '/api/v1/mjml') { + header('Content-Type: application/json'); + try { + echo json_encode([ + 'status' => 'ok', + 'content' => (new self)->process($_POST['template'] ?? ''), + ]); + } catch (\Throwable $e) { + echo json_encode([ + 'status' => 'error', + 'message' => $e->getMessage(), + ]); + } + die; + } + } + + + /** + * @param string $template + * @return string + */ + public function process(string $template): string + { + $templateContentHash = md5($template); + $sourceFile = $this->cacheDir . '/' . $templateContentHash . '.mjml'; + $finalFile = $this->cacheDir . '/' . $templateContentHash . '.html'; + + if (\is_file($finalFile)) { + return $this->processReturn($finalFile); + } + + $this->write($sourceFile, $template); + + if ($this->functionIsAvailable('shell_exec') === false) { + throw new \RuntimeException('Function shell_exec() is disabled on this server.'); + } + + shell_exec('/node_modules/.bin/mjml ' . escapeshellarg($sourceFile) . ' > ' . escapeshellarg($finalFile)); + + return $this->processReturn($finalFile); + } + + + /** + * @param string $file + * @return string + */ + private function processReturn(string $file): string + { + $return = str_replace(["\r\n", "\r"], "\n", $this->read($file)); + + if (preg_match('/Error: ([^\n]+)/', $return, $parser)) { + throw new \RuntimeException($parser[1]); + } + + return $return; + } + + + /** + * @param string $dir + * @param int $mode + */ + private function createDir(string $dir, int $mode = 0777): void + { + if (!is_dir($dir) && !@mkdir($dir, $mode, true) && !is_dir($dir)) { // @ - dir may already exist + throw new \RuntimeException('Unable to create directory "' . $dir . '". ' . $this->getLastError()); + } + } + + + /** + * @param string $file + * @return string + */ + private function read(string $file): string + { + $content = @file_get_contents($file); // @ is escalated to exception + if ($content === false) { + throw new \RuntimeException("Unable to read file '$file'. " . $this->getLastError()); + } + + return $content; + } + + + /** + * @param string $file + * @param string $content + * @param int|null $mode + */ + private function write(string $file, string $content, ?int $mode = 0666): void + { + $this->createDir(dirname($file)); + if (@file_put_contents($file, $content) === false) { // @ is escalated to exception + throw new \RuntimeException("Unable to write file '$file'. " . $this->getLastError()); + } + if ($mode !== null && !@chmod($file, $mode)) { // @ is escalated to exception + throw new \RuntimeException("Unable to chmod file '$file'. " . $this->getLastError()); + } + } + + + /** + * @return string + */ + private function getLastError(): string + { + return preg_replace('#^\w+\(.*?\): #', '', error_get_last()['message']); + } + + + /** + * @param string $functionName + * @return bool + */ + private function functionIsAvailable(string $functionName): bool + { + static $disabled; + + if (\function_exists($functionName)) { + if ($disabled === null && \is_string($disableFunctions = ini_get('disable_functions'))) { + $disabled = explode(',', $disableFunctions) ?: []; + } + + return \in_array($functionName, $disabled, true) === false; + } + + return false; + } +} \ No newline at end of file