From bd916331c87539ed227a9b731888d5eea38096ac Mon Sep 17 00:00:00 2001 From: EndMove Date: Mon, 8 Aug 2022 19:30:07 +0200 Subject: [PATCH] initial commit --- .gitignore | 1 + LICENSE | 202 ++++++++++++++++++++++++++++++++++ README.md | 63 +++++++++++ phar-creator.php | 91 +++++++++++++++ src/factory/personFactory.php | 21 ++++ src/main.php | 36 ++++++ src/model/Person.php | 50 +++++++++ src/utils/func.php | 22 ++++ win-build.cmd | 8 ++ 9 files changed, 494 insertions(+) create mode 100644 .gitignore create mode 100644 LICENSE create mode 100644 README.md create mode 100644 phar-creator.php create mode 100644 src/factory/personFactory.php create mode 100644 src/main.php create mode 100644 src/model/Person.php create mode 100644 src/utils/func.php create mode 100644 win-build.cmd diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..1a3b99b --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +/build/** \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..47a0d64 --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ + + 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 [2022] [Jérémi Nihart] + + 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. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..63030de --- /dev/null +++ b/README.md @@ -0,0 +1,63 @@ +# phar-creator + +[![Donate][link-icon-coffee]][link-paypal-me] [![Website][link-icon-website]][link-website] + +[link-icon-coffee]: https://img.shields.io/badge/%E2%98%95-Buy%20me%20a%20cup%20of%20coffee-991481.svg +[link-paypal-me]: https://www.paypal.me/EndMove/2.5eur +[link-icon-website]: https://img.shields.io/badge/%F0%9F%92%BB-My%20Web%20Site-0078D4.svg +[link-website]: https://www.endmove.eu/ + +## Description + +Phar-Creator is a PHP compaction tool that allows you to compress your project, library, etc. into a `.phar` archive, so that you have a single file containing them all. +You can freely add an entry point in case your program is made to be executed directly by client, a web entry point, or meta data and more. +The compaction tool will also provide you with a Sha256 fingerprint of the resulting `.phar`. + +## Use + +You will find below the two modes of use of the tool, the first by using the provided windows executable `win-build.cmd` or the `CLI` (terminal). The second one by accessing directly the script via internet (`WEB`). + +For these two modes of use you will have to configure the script in the section `CONSTANTS to config`. This repository is already a complete example of phar-creator use. Our example is called __hello-world__ it has been made to be as understandable as possible I invite you to browse it to discover the structure (people used to it can abstain). + +### CLI packaging + +#### Requirements + +- PHP version `>= 7.4` ; +- PHP must be `CLI ready` (**win**: add to environement variable, **linux**: installed) ; + +#### Examples by method + +1) Run the script directly into your terminal `php -dphar.readonly=0 phar-creator.php`. +2) Run the `win-build.cmd` script. + +### WEB packaging + +#### Requirements + +- PHP version `>= 7.4` ; +- The web server must have `read and write permissions` or run as administrator ; +- In the php.ini, `phar.readonly` must be disabled, so set to `false` ; + +#### Example web + +* Simply navigate to the access url of the script `http://your-website.domain/phar-creator.php`.:k:= + +## Project structure (example) +````txt +* +│ phar-creator.php ==> The main tool to place in project's root directory. +│ LICENSE +│ README.md +│ win-build.cmd ==> The windows script to start the tool. +├───build ==> The build directory. +│ hello-world.phar +└───src ==> The source code directory. + │ main.php ==> The hello-world (example) entrypoint. + ├───factory + │ personFactory.php + ├───model + │ Person.php + └───utils + func.php +```` \ No newline at end of file diff --git a/phar-creator.php b/phar-creator.php new file mode 100644 index 0000000..01f1a1a --- /dev/null +++ b/phar-creator.php @@ -0,0 +1,91 @@ += 7.4 + * + * @version 1.0.0 + * @since 08-08-2022 + * + * @author Jérémi Nihart + * @copyright © 2022 EndMove, All rights reserved. + * + * @link https://www.endmove.eu/ + */ +declare(strict_types=1); + +// CONSTANTS - to config +const FILE_NAME = 'hello-world.phar'; // the package name, must end by '.phar' +const SOURCE_FOLDER = '/src'; // the source folder, usualy 'src' +const OUTPUT_FOLDER = '/build'; // the output folder, usualy 'build' +const CLI_ENTRY_POINT = 'main.php'; // the program/library entry point for cli use, usualy 'main.php' +const WEB_ENTRY_POINT = null; // the program entry point for web use, usualy 'web_index.php' +const USE_SHEBANG = false; // use shebang for fast click execution on linux, usualy 'false' +const META_DATA = [ // the meta-data to merge with the phar package. + 'version' => '1.0.0', + 'author' => 'EndMove', + 'website' => 'https://www.endmove.eu' +]; + +// PROGRAM +try { + $output = __DIR__ . OUTPUT_FOLDER . '/'; + + // clean + if (!file_exists($output)) { + echo "Build directory has been created\n"; + mkdir($output, 0770); + } + + // clean & update output + $output .= FILE_NAME; + if (file_exists($output)) { + echo "Cleaning old files...\n"; + unlink($output); + } + + // create phar + echo "=== Start creating (.phar) package ===\n"; + $phar = new Phar($output); + + // buffering START + echo "-> Buffering files...\n"; + $phar->startBuffering(); + + // packaging project + echo "-> Packaging project...\n"; + $phar->buildFromDirectory(__DIR__ . SOURCE_FOLDER); + echo "-> Packaging project. Done!\n"; + + // create stub + echo "-> Creating stub...\n"; + $stub = $phar->createDefaultStub(CLI_ENTRY_POINT, WEB_ENTRY_POINT); + $phar->setStub(USE_SHEBANG ? "#!/usr/bin/env php \n$stub" : $stub); + echo "-> Creating stub. Done!\n"; + + // add meta-data + $phar->setMetadata(META_DATA); + echo "-> Meta-data added!\n"; + + // buffering STOP + $phar->stopBuffering(); + echo "-> Buffering files. Done!\n"; + + // compressing package content + echo "-> compressing package...\n"; + $phar->compressFiles(Phar::GZ); + echo "-> compressing package. Done!\n"; + + // chmod perm + chmod($output, 0770); + echo "OK. Project successfuly packaged into ($output).\n"; + echo "Generated phar SHA256 fingerprint : " . hash_file('sha256', $output) . PHP_EOL; +} catch (Exception $e) { + echo("ERROR : " . $e->getMessage()); + exit(1); +} +exit(0); \ No newline at end of file diff --git a/src/factory/personFactory.php b/src/factory/personFactory.php new file mode 100644 index 0000000..8af6c35 --- /dev/null +++ b/src/factory/personFactory.php @@ -0,0 +1,21 @@ + + */ +function makePersons(): array +{ + return [ + new Person("Jérémi", "Nihart", 20), + new Person("Coralie", "Florquin", 21), + new Person("Guillaume", "Vander"), + new Person("Samuel", "Nihart", 17), + new Person("Michel", "Laroux", null) + ]; +} \ No newline at end of file diff --git a/src/main.php b/src/main.php new file mode 100644 index 0000000..1bd2726 --- /dev/null +++ b/src/main.php @@ -0,0 +1,36 @@ + Model, Factory, Utils; then run closure +require_once __DIR__ . '/model/Person.php'; +require_once __DIR__ . '/factory/personFactory.php'; +require_once __DIR__ . '/utils/func.php'; + +// Entry point +(function() +{ + $persons = makePersons(); // make demo persons + + echo "==> To beging I will print the data generated by the Person Factory.\n"; // first print + sayHelloToAll($persons); // display hello message + + echo "\n==> Now I will edit some data with magic method...\n"; // edit some data + $persons[0]->lastname = 'New Last Name Very Long LMAO'; + $persons[3]->lastname = 'An Other Very Long Last Name'; + $persons[4]->lastname = 'An New FirstName'; + sayHelloToAll($persons); // display hello message + + echo "\n==> Now I will edit the age and show it with magic methods...\n"; // edit age, reboot lastname and display + $persons[0]->lastname = 'Nihart'; + echo "BEFORE: " . $persons[0]->getFormattedName() . " & age=" . $persons[0]->age . "\n"; + $persons[0]->age = 10; + echo "AFTER: " . $persons[0]->getFormattedName() . " & age=" . $persons[0]->age . "\n"; + $persons[0]->age = -20; + echo "AFTER 2 WITH NO EFFECT: " . $persons[0]->getFormattedName() . " & age=" . $persons[0]->age . "\n"; +} +)(); \ No newline at end of file diff --git a/src/model/Person.php b/src/model/Person.php new file mode 100644 index 0000000..1389d93 --- /dev/null +++ b/src/model/Person.php @@ -0,0 +1,50 @@ +firstname = $firstname; + $this->lastname = $lastname; + $this->age = isset($age) ? $age : -1; + } + + // Magic getter + public function __get(string $val): mixed + { + return isset($this->$val) ? $this->$val : "Unknown attribut"; + } + + // Magic setter + public function __set(string $val, mixed $value): void + { + if (!(isset($this->$val) && gettype($this->$val) == gettype($value))) return; + switch ($val) { + case 'age': + $this->$val = $value > -1 ? $value : $this->$val; + break; + default: + $this->$val = $value; + break; + } + } + + /** + * Retrieve the formated name + */ + public function getFormattedName(): string + { + return sprintf("%s %s", strtoupper($this->lastname), ucfirst(strtolower($this->firstname))); + } +} \ No newline at end of file diff --git a/src/utils/func.php b/src/utils/func.php new file mode 100644 index 0000000..aafb794 --- /dev/null +++ b/src/utils/func.php @@ -0,0 +1,22 @@ +getFormattedName() . " !"; +} + +/** + * Say hello world to a person list + */ +function sayHelloToAll(array $persons): void +{ + foreach ($persons as $person) echo(getHelloTo($person) . "\n"); +} \ No newline at end of file diff --git a/win-build.cmd b/win-build.cmd new file mode 100644 index 0000000..da40e18 --- /dev/null +++ b/win-build.cmd @@ -0,0 +1,8 @@ +@ECHO OFF +ECHO You are running win-phar-creator by EndMove +ECHO ------------------------------------------- +php -dphar.readonly=0 phar-creator.php +ECHO ==================================================== +ECHO THE EXECUTION OF THE CONSTRUCTION SCRIPT IS FINISHED +ECHO ==================================================== +TIMEOUT /T 20 \ No newline at end of file