From c7f8e55cb950515c03254112023540a09eb54950 Mon Sep 17 00:00:00 2001 From: Sven Wappler Date: Mon, 10 Aug 2026 22:31:06 +0200 Subject: [PATCH] TYPO3 v15 dev-main snapshot () --- .gitignore | 1 + .php-cs-fixer.dist.php | 95 +++++ LICENSE.txt | 339 ++++++++++++++++++ README.md | 50 +++ composer.json | 69 ++++ res/php/autoload-include.tmpl.php | 18 + src/Installer/Plugin.php | 105 ++++++ src/Plugin/Config.php | 252 +++++++++++++ src/Plugin/Core/IncludeFile.php | 111 ++++++ src/Plugin/Core/IncludeFile/AppDirToken.php | 79 ++++ src/Plugin/Core/IncludeFile/BaseDirToken.php | 79 ++++ .../Core/IncludeFile/ComposerModeToken.php | 78 ++++ src/Plugin/Core/IncludeFile/RootDirToken.php | 79 ++++ .../Core/IncludeFile/TokenInterface.php | 34 ++ src/Plugin/Core/IncludeFile/WebDirToken.php | 79 ++++ src/Plugin/Core/InstallerScript.php | 31 ++ .../Core/InstallerScripts/EntryPoint.php | 67 ++++ .../Core/InstallerScriptsRegistration.php | 37 ++ src/Plugin/Core/ScriptDispatcher.php | 117 ++++++ .../Core/StopInstallerScriptExecution.php | 24 ++ src/Plugin/PluginImplementation.php | 95 +++++ src/Plugin/Util/ExtensionKeyResolver.php | 49 +++ .../Plugin/Util/ExtensionKeyResolverTest.php | 83 +++++ 23 files changed, 1971 insertions(+) create mode 100644 .gitignore create mode 100644 .php-cs-fixer.dist.php create mode 100644 LICENSE.txt create mode 100644 README.md create mode 100644 composer.json create mode 100644 res/php/autoload-include.tmpl.php create mode 100644 src/Installer/Plugin.php create mode 100644 src/Plugin/Config.php create mode 100644 src/Plugin/Core/IncludeFile.php create mode 100644 src/Plugin/Core/IncludeFile/AppDirToken.php create mode 100644 src/Plugin/Core/IncludeFile/BaseDirToken.php create mode 100644 src/Plugin/Core/IncludeFile/ComposerModeToken.php create mode 100644 src/Plugin/Core/IncludeFile/RootDirToken.php create mode 100644 src/Plugin/Core/IncludeFile/TokenInterface.php create mode 100644 src/Plugin/Core/IncludeFile/WebDirToken.php create mode 100644 src/Plugin/Core/InstallerScript.php create mode 100644 src/Plugin/Core/InstallerScripts/EntryPoint.php create mode 100644 src/Plugin/Core/InstallerScriptsRegistration.php create mode 100644 src/Plugin/Core/ScriptDispatcher.php create mode 100644 src/Plugin/Core/StopInstallerScriptExecution.php create mode 100644 src/Plugin/PluginImplementation.php create mode 100644 src/Plugin/Util/ExtensionKeyResolver.php create mode 100644 tests/Plugin/Util/ExtensionKeyResolverTest.php diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..57872d0 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +/vendor/ diff --git a/.php-cs-fixer.dist.php b/.php-cs-fixer.dist.php new file mode 100644 index 0000000..bb4659a --- /dev/null +++ b/.php-cs-fixer.dist.php @@ -0,0 +1,95 @@ +setRiskyAllowed(true) + ->setUsingCache(false) + ->setParallelConfig(ParallelConfigFactory::detect()) + ->setFinder( + PhpCsFixer\Finder::create() + ->in(__DIR__) + ->exclude('res') + ->exclude('vendor') + ->notName('autoload-include.php') + ) + ->setRules([ + '@PSR2' => true, + 'header_comment' => [ + 'header' => $header + ], + 'array_syntax' => [ + 'syntax' => 'short', + ], + 'binary_operator_spaces' => true, + 'blank_lines_before_namespace' => true, + 'class_attributes_separation' => true, + 'concat_space' => [ + 'spacing' => 'one', + ], + 'linebreak_after_opening_tag' => true, + 'lowercase_cast' => true, + 'multiline_whitespace_before_semicolons' => true, + 'native_function_casing' => true, + 'new_with_parentheses' => true, + 'no_alias_functions' => true, + 'no_blank_lines_after_class_opening' => true, + 'no_blank_lines_after_phpdoc' => true, + 'no_empty_comment' => true, + 'no_empty_phpdoc' => true, + 'no_empty_statement' => true, + 'no_extra_blank_lines' => true, + 'no_leading_import_slash' => true, + 'no_leading_namespace_whitespace' => true, + 'no_multiline_whitespace_around_double_arrow' => true, + 'no_short_bool_cast' => true, + 'no_singleline_whitespace_before_semicolons' => true, + 'no_trailing_comma_in_singleline' => true, + 'no_unneeded_control_parentheses' => true, + 'no_unreachable_default_argument_value' => true, + 'no_unused_imports' => true, + 'no_useless_else' => true, + 'no_useless_return' => true, + 'no_whitespace_before_comma_in_array' => true, + 'no_whitespace_in_blank_line' => true, + 'normalize_index_brace' => true, + 'ordered_imports' => true, + 'phpdoc_add_missing_param_annotation' => true, + 'phpdoc_no_package' => true, + 'phpdoc_order' => true, + 'phpdoc_scalar' => true, + 'phpdoc_types' => true, + 'self_accessor' => true, + 'short_scalar_cast' => true, + 'single_line_comment_style' => [ + 'comment_types' => ['hash'], + ], + 'single_quote' => true, + 'standardize_not_equals' => true, + 'ternary_operator_spaces' => true, + 'trailing_comma_in_multiline' => [ + 'elements' => ['arrays'], + ], + 'type_declaration_spaces' => true, + 'whitespace_after_comma_in_array' => true, + ]); diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..d159169 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,339 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Lesser General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License along + with this program; if not, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + , 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. diff --git a/README.md b/README.md new file mode 100644 index 0000000..8f77d6e --- /dev/null +++ b/README.md @@ -0,0 +1,50 @@ +[![CI Status](https://github.com/TYPO3/CmsComposerInstallers/workflows/CI/badge.svg?branch=master)](https://github.com/TYPO3/CmsComposerInstallers/actions?query=workflow%3ACI) + +# TYPO3 CMS Composer installers + +This package acts as composer plugin in order to download and install TYPO3 +core and extensions and put them into a directory structure which is suitable +for TYPO3 to work correctly. + +The behavior of the installer can be influenced by configuration in the `extra` +section of the root `composer.json`. + +## Options for extension composer.json + +### `extension-key` (required) + +```json + "extra": { + "typo3/cms": { + "extension-key": "bootstrap_package" + } + } +``` + +Specifies the extension key. This is mandatory and extensions will stop to work +with version 4 of this package if not provided properly. + +A warning is show by Composer if this key is missing in a extension. + +## Options for project composer.json + +### `web-dir` + +```json + "extra": { + "typo3/cms": { + "web-dir": "public" + } + } +``` + +You can specify a relative path from the base directory, where the public +document root should be located. + +*The default value* is `"public"`, which means a `"public"` directory at the +same level as your root `composer.json`. + +## Feedback / Bug reports / Contribution + +Bug reports, feature requests and pull requests are welcome in the GitHub +repository: diff --git a/composer.json b/composer.json new file mode 100644 index 0000000..0cdcc2a --- /dev/null +++ b/composer.json @@ -0,0 +1,69 @@ +{ + "name": "typo3/cms-composer-installers", + "type": "composer-plugin", + "description": "TYPO3 CMS Installers", + "keywords": [ + "installer", "typo3", "cms", "core", "extension" + ], + "homepage": "https://github.com/TYPO3/CmsComposerInstallers", + "license": "GPL-2.0-or-later", + "authors": [ + { + "name": "TYPO3 CMS Core Team", + "role": "Developer", + "homepage": "https://forge.typo3.org/projects/typo3cms-core" + }, + { + "name": "The TYPO3 Community", + "role": "Contributor", + "homepage": "https://typo3.org/community/" + } + ], + "support": { + "general": "https://typo3.org/support/", + "issues": "https://github.com/TYPO3/CmsComposerInstallers/issues" + }, + "autoload": { + "psr-4": { + "TYPO3\\CMS\\Composer\\": "src/" + } + }, + "autoload-dev": { + "psr-4": { + "TYPO3\\CMS\\ComposerTest\\": "tests/" + } + }, + "replace": { + "lw/typo3cms-installers": "*", + "netresearch/composer-installers": "*" + }, + "require": { + "php": "^8.1", + "composer-plugin-api": "^2.1.0" + }, + "require-dev": { + "composer/composer": "^2.1", + "overtrue/phplint": "^9.4.1", + "phpunit/phpunit": "^10.5.30", + "friendsofphp/php-cs-fixer": "^3.62.0" + }, + "scripts": { + "test:php:lint": [ + "phplint" + ], + "test:php:unit": [ + "Composer\\Config::disableProcessTimeout", + "phpunit" + ], + "test": [ + "@test:php:lint", + "@test:php:unit" + ] + }, + "extra": { + "class": "TYPO3\\CMS\\Composer\\Installer\\Plugin", + "branch-alias": { + "dev-main": "5.0.x-dev" + } + } +} diff --git a/res/php/autoload-include.tmpl.php b/res/php/autoload-include.tmpl.php new file mode 100644 index 0000000..72be62b --- /dev/null +++ b/res/php/autoload-include.tmpl.php @@ -0,0 +1,18 @@ + ['listen'], + ScriptEvents::POST_AUTOLOAD_DUMP => ['listen'], + ]; + } + + /** + * {@inheritDoc} + */ + public function activate(Composer $composer, IOInterface $io) + { + $composer->getEventDispatcher()->addSubscriber($this); + } + + public function deactivate(Composer $composer, IOInterface $io) + { + // Nothing to do + } + + public function uninstall(Composer $composer, IOInterface $io) + { + // Nothing to do + } + + /** + * Listens to Composer events. + * + * This method is very minimalist on purpose. We want to load the actual + * implementation only after updating the Composer packages so that we get + * the updated version (if available). + * + * @param Event $event The Composer event. + */ + public function listen(Event $event) + { + if (!empty($this->handledEvents[$event->getName()])) { + return; + } + $this->handledEvents[$event->getName()] = true; + // Plugin has been uninstalled + if (!file_exists(__FILE__) || !file_exists(dirname(__DIR__) . '/Plugin/PluginImplementation.php')) { + return; + } + + // Load the implementation only after updating Composer so that we get + // the new version of the plugin when a new one was installed + if (null === $this->pluginImplementation) { + $this->pluginImplementation = new PluginImplementation($event); + } + + switch ($event->getName()) { + case ScriptEvents::PRE_AUTOLOAD_DUMP: + $this->pluginImplementation->preAutoloadDump(); + break; + case ScriptEvents::POST_AUTOLOAD_DUMP: + $this->pluginImplementation->postAutoloadDump(); + break; + } + } +} diff --git a/src/Plugin/Config.php b/src/Plugin/Config.php new file mode 100644 index 0000000..3ff234f --- /dev/null +++ b/src/Plugin/Config.php @@ -0,0 +1,252 @@ + 'public', + 'root-dir' => '{$web-dir}', + 'app-dir' => '{$base-dir}', + // The following values are for internal use only and do not represent public API + // Names and behaviour of these values might change without notice + 'composer-mode' => true, + ]; + + /** + * @var array + */ + protected $config; + + /** + * @var string + */ + protected $baseDir; + + /** + * @param string $baseDir + */ + public function __construct($baseDir = null) + { + $this->baseDir = $baseDir; + // load defaults + $this->config = static::$defaultConfig; + } + + /** + * Merges new config values with the existing ones (overriding) + * + * @param array $config + */ + public function merge(array $config) + { + // Override defaults with given config + if (!empty($config['typo3/cms']) && is_array($config['typo3/cms'])) { + foreach ($config['typo3/cms'] as $key => $val) { + $this->config[$key] = $val; + } + } + } + + /** + * Returns a setting + * + * @param string $key + * @param int $flags Options (see class constants) + * @return mixed + */ + public function get($key, $flags = 0) + { + switch ($key) { + case 'web-dir': + case 'root-dir': + case 'app-dir': + $val = rtrim($this->process($this->config[$key], $flags), '/\\'); + return ($flags & self::RELATIVE_PATHS === 1) ? $val : $this->realpath($val); + case 'base-dir': + return ($flags & self::RELATIVE_PATHS === 1) ? '' : $this->realpath($this->baseDir); + default: + if (!isset($this->config[$key])) { + return null; + } + return $this->process($this->config[$key], $flags); + } + } + + /** + * @param int $flags Options (see class constants) + * @return array + */ + public function all($flags = 0) + { + $all = []; + foreach (array_keys($this->config) as $key) { + $all['config'][$key] = $this->get($key, $flags); + } + + return $all; + } + + /** + * @return array + */ + public function raw() + { + return [ + 'config' => $this->config, + ]; + } + + /** + * Checks whether a setting exists + * + * @param string $key + * @return bool + */ + public function has($key) + { + return array_key_exists($key, $this->config); + } + + /** + * Replaces {$refs} inside a config string + * + * @param string $value a config string that can contain {$refs-to-other-config} + * @param int $flags Options (see class constants) + * @return string + */ + protected function process($value, $flags) + { + $config = $this; + + if (!is_string($value)) { + return $value; + } + + return preg_replace_callback( + '#\{\$(.+)\}#', + function ($match) use ($config, $flags) { + return $config->get($match[1], $flags); + }, + $value + ); + } + + /** + * Turns relative paths in absolute paths without realpath() + * + * Since the dirs might not exist yet we can not call realpath or it will fail. + * + * @param string $path + * @return string + */ + protected function realpath($path) + { + if ($path === '') { + return $this->baseDir; + } + if ($path[0] === '/' || (!empty($path[1]) && $path[1] === ':')) { + return $path; + } + + return $this->baseDir . '/' . $path; + } + + /** + * @return string + */ + public function getBaseDir() + { + return $this->baseDir; + } + + /** + * @param Composer $composer + * @param IOInterface|null $io + * @return Config + */ + public static function load(Composer $composer, ?IOInterface $io = null) + { + static $config; + if ($config === null) { + $io = $io ?? new NullIO(); + $baseDir = static::extractBaseDir($composer->getConfig()); + $rootPackageExtraConfig = self::handleRootPackageExtraConfig($io, $composer->getPackage()); + $config = new static($baseDir); + $config->merge($rootPackageExtraConfig); + } + return $config; + } + + private static function handleRootPackageExtraConfig(IOInterface $io, RootPackageInterface $rootPackage): array + { + if ($rootPackage->getName() === 'typo3/cms') { + // Configuration for the web dir is different, in case + // typo3/cms is the root package + self::$defaultConfig['web-dir'] = '.'; + + return []; + } + $rootPackageExtraConfig = $rootPackage->getExtra() ?: []; + $typo3Config = $rootPackageExtraConfig['typo3/cms'] ?? []; + if (empty($typo3Config)) { + return $rootPackageExtraConfig; + } + if (isset($rootPackageExtraConfig['typo3/cms']['app-dir'])) { + $io->warning('Changing app-dir is not supported any more. TYPO3 application dir will always be set to Composer root directory'); + } + if (isset($rootPackageExtraConfig['typo3/cms']['root-dir'])) { + $io->warning('Changing root-dir is not supported any more. TYPO3 root-dir will always be the same as web-dir'); + } + unset($rootPackageExtraConfig['typo3/cms']['root-dir'], $rootPackageExtraConfig['typo3/cms']['app-dir']); + $fileSystem = new Filesystem(); + $config = new static('/fake/root'); + $config->merge($rootPackageExtraConfig); + $baseDir = $fileSystem->normalizePath($config->get('base-dir')); + $webDir = $fileSystem->normalizePath($config->get('web-dir')); + if (!str_starts_with($webDir, $baseDir)) { + unset($rootPackageExtraConfig['typo3/cms']['web-dir']); + $io->writeError('TYPO3 public path must be a subdirectory of Composer root directory. Resetting web-dir config to default.'); + } + + return $rootPackageExtraConfig; + } + + /** + * @param \Composer\Config $config + * @return mixed + */ + protected static function extractBaseDir(\Composer\Config $config) + { + $reflectionClass = new \ReflectionClass($config); + $reflectionProperty = $reflectionClass->getProperty('baseDir'); + return $reflectionProperty->getValue($config); + } +} diff --git a/src/Plugin/Core/IncludeFile.php b/src/Plugin/Core/IncludeFile.php new file mode 100644 index 0000000..4b2b2f8 --- /dev/null +++ b/src/Plugin/Core/IncludeFile.php @@ -0,0 +1,111 @@ +io = $io; + $this->composer = $composer; + $this->tokens = $tokens; + $this->filesystem = $filesystem ?: new Filesystem(); + } + + public function register() + { + $this->io->writeError('Register typo3/cms-composer-installer file in root package autoload definition', true, IOInterface::VERBOSE); + + // Generate and write the file + $includeFile = $this->composer->getConfig()->get('vendor-dir') . self::INCLUDE_FILE; + file_put_contents($includeFile, $this->getIncludeFileContent(dirname($includeFile))); + + // Register the file in the root package + $rootPackage = $this->composer->getPackage(); + $autoloadDefinition = $rootPackage->getAutoload(); + $autoloadDefinition['files'][] = $includeFile; + $rootPackage->setAutoload($autoloadDefinition); + + // Load it to expose the paths to further plugin functionality + require $includeFile; + } + + /** + * Constructs the include file content + * + * @param string $includeFilePath + * @throws \RuntimeException + * @throws \InvalidArgumentException + * @return string + */ + protected function getIncludeFileContent(string $includeFilePath) + { + $includeFileTemplate = $this->filesystem->normalizePath(dirname(dirname(dirname(__DIR__))) . self::INCLUDE_FILE_TEMPLATE); + $includeFileContent = file_get_contents($includeFileTemplate); + foreach ($this->tokens as $token) { + $includeFileContent = self::replaceToken($token->getName(), $token->getContent($includeFilePath), $includeFileContent); + } + return $includeFileContent; + } + + /** + * Replaces a token in the subject (PHP code) + * + * @param string $name + * @param string $content + * @param string $subject + * @return string + */ + private static function replaceToken($name, $content, $subject) + { + return str_replace('\'{$' . $name . '}\'', $content, $subject); + } +} diff --git a/src/Plugin/Core/IncludeFile/AppDirToken.php b/src/Plugin/Core/IncludeFile/AppDirToken.php new file mode 100644 index 0000000..2268286 --- /dev/null +++ b/src/Plugin/Core/IncludeFile/AppDirToken.php @@ -0,0 +1,79 @@ +io = $io; + $this->typo3PluginConfig = $typo3PluginConfig; + $this->filesystem = $filesystem ?: new Filesystem(); + } + + /** + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * @param string $includeFilePath + * @throws \InvalidArgumentException + * @return string + */ + public function getContent(string $includeFilePath) + { + return $this->filesystem->findShortestPathCode( + $includeFilePath, + $this->typo3PluginConfig->get('app-dir'), + true + ); + } +} diff --git a/src/Plugin/Core/IncludeFile/BaseDirToken.php b/src/Plugin/Core/IncludeFile/BaseDirToken.php new file mode 100644 index 0000000..d71021b --- /dev/null +++ b/src/Plugin/Core/IncludeFile/BaseDirToken.php @@ -0,0 +1,79 @@ +io = $io; + $this->typo3PluginConfig = $typo3PluginConfig; + $this->filesystem = $filesystem ?: new Filesystem(); + } + + /** + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * @param string $includeFilePath + * @throws \InvalidArgumentException + * @return string + */ + public function getContent(string $includeFilePath) + { + return $this->filesystem->findShortestPathCode( + $includeFilePath, + $this->typo3PluginConfig->getBaseDir(), + true + ); + } +} diff --git a/src/Plugin/Core/IncludeFile/ComposerModeToken.php b/src/Plugin/Core/IncludeFile/ComposerModeToken.php new file mode 100644 index 0000000..6f9a2f3 --- /dev/null +++ b/src/Plugin/Core/IncludeFile/ComposerModeToken.php @@ -0,0 +1,78 @@ +io = $io; + $this->pluginConfig = $pluginConfig; + } + + /** + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * @param string $includeFilePath + * @throws \InvalidArgumentException + * @return string + */ + public function getContent(string $includeFilePath) + { + if (!$this->pluginConfig->get('composer-mode')) { + return 'TYPO3 is installed via composer, but for development reasons the additional class loader is activated. Handle with care!'; + } + + $this->io->writeError('Inserting TYPO3_COMPOSER_MODE constant', true, IOInterface::VERBOSE); + + return <<io = $io; + $this->typo3PluginConfig = $typo3PluginConfig; + $this->filesystem = $filesystem ?: new Filesystem(); + } + + /** + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * @param string $includeFilePath + * @throws \InvalidArgumentException + * @return string + */ + public function getContent(string $includeFilePath) + { + return $this->filesystem->findShortestPathCode( + $includeFilePath, + $this->typo3PluginConfig->get('root-dir'), + true + ); + } +} diff --git a/src/Plugin/Core/IncludeFile/TokenInterface.php b/src/Plugin/Core/IncludeFile/TokenInterface.php new file mode 100644 index 0000000..3cd2cc7 --- /dev/null +++ b/src/Plugin/Core/IncludeFile/TokenInterface.php @@ -0,0 +1,34 @@ +io = $io; + $this->typo3PluginConfig = $typo3PluginConfig; + $this->filesystem = $filesystem ?: new Filesystem(); + } + + /** + * @return string + */ + public function getName() + { + return $this->name; + } + + /** + * @param string $includeFilePath + * @throws \InvalidArgumentException + * @return string + */ + public function getContent(string $includeFilePath) + { + return $this->filesystem->findShortestPathCode( + $includeFilePath, + $this->typo3PluginConfig->get('web-dir'), + true + ); + } +} diff --git a/src/Plugin/Core/InstallerScript.php b/src/Plugin/Core/InstallerScript.php new file mode 100644 index 0000000..caea903 --- /dev/null +++ b/src/Plugin/Core/InstallerScript.php @@ -0,0 +1,31 @@ +source = $source; + $this->target = $target; + } + + public function run(Event $event): bool + { + $composer = $event->getComposer(); + $filesystem = new Filesystem(); + $pluginConfig = Config::load($composer); + + $entryPointContent = file_get_contents($this->source); + $targetFile = $pluginConfig->get('web-dir') . '/' . $this->target; + $autoloadFile = $composer->getConfig()->get('vendor-dir') . '/autoload.php'; + + $entryPointContent = preg_replace( + '/__DIR__ . \'[^\']*\'/', + $filesystem->findShortestPathCode($targetFile, $autoloadFile), + $entryPointContent + ); + + $filesystem->ensureDirectoryExists(dirname($targetFile)); + file_put_contents($targetFile, $entryPointContent); + + return true; + } +} diff --git a/src/Plugin/Core/InstallerScriptsRegistration.php b/src/Plugin/Core/InstallerScriptsRegistration.php new file mode 100644 index 0000000..fc84d37 --- /dev/null +++ b/src/Plugin/Core/InstallerScriptsRegistration.php @@ -0,0 +1,37 @@ + + */ +interface InstallerScriptsRegistration +{ + /** + * Allows to register one or more script objects that implement this interface + * This will be called in the Plugin right before the scripts are executed. + * + * @param Event $event + * @param ScriptDispatcher $scriptDispatcher + * @return void + */ + public static function register(Event $event, ScriptDispatcher $scriptDispatcher); +} diff --git a/src/Plugin/Core/ScriptDispatcher.php b/src/Plugin/Core/ScriptDispatcher.php new file mode 100644 index 0000000..755d547 --- /dev/null +++ b/src/Plugin/Core/ScriptDispatcher.php @@ -0,0 +1,117 @@ +event = $event; + } + + /** + * @param InstallerScript $script The callable that will be executed + * @param int $priority Higher priority results in earlier execution + */ + public function addInstallerScript(InstallerScript $script, $priority = 50) + { + $this->installerScripts[$priority][] = $script; + } + + public function executeScripts() + { + $io = $this->event->getIO(); + $this->registerLoader(); + + ksort($this->installerScripts, SORT_NUMERIC); + $io->writeError('Executing TYPO3 installer scripts', true, $io::VERBOSE); + try { + foreach (array_reverse($this->installerScripts) as $scripts) { + /** @var InstallerScript $script */ + foreach ($scripts as $script) { + $io->writeError(sprintf('Executing "%s": ', get_class($script)), true, $io::DEBUG); + if (!$script->run($this->event)) { + $io->writeError(sprintf('Executing "%s" failed.', get_class($script)), true); + } + } + } + } catch (StopInstallerScriptExecution $e) { + // Just skip further script execution + } finally { + $this->unRegisterLoader(); + } + } + + private function registerLoader() + { + $composer = $this->event->getComposer(); + $package = $composer->getPackage(); + $generator = $composer->getAutoloadGenerator(); + $packages = $composer->getRepositoryManager()->getLocalRepository()->getCanonicalPackages(); + $packageMap = $generator->buildPackageMap($composer->getInstallationManager(), $package, $packages); + $map = $generator->parseAutoloads($packageMap, $package); + $this->loader = $generator->createLoader($map); + $this->loader->register(); + if (!empty($map['psr-4']) && is_array($map['psr-4'])) { + $this->registerInstallerScripts(array_keys($map['psr-4'])); + } + } + + private function registerInstallerScripts(array $psr4Namespaces) + { + foreach ($psr4Namespaces as $psr4Namespace) { + /** @var InstallerScriptsRegistration $scriptsRegistrationCandidate */ + $scriptsRegistrationCandidate = $psr4Namespace . 'Composer\\InstallerScripts'; + if ( + class_exists($scriptsRegistrationCandidate) + && in_array(InstallerScriptsRegistration::class, class_implements($scriptsRegistrationCandidate), true) + ) { + $scriptsRegistrationCandidate::register($this->event, $this); + } + } + } + + private function unRegisterLoader() + { + $this->loader->unregister(); + } +} diff --git a/src/Plugin/Core/StopInstallerScriptExecution.php b/src/Plugin/Core/StopInstallerScriptExecution.php new file mode 100644 index 0000000..d056a7f --- /dev/null +++ b/src/Plugin/Core/StopInstallerScriptExecution.php @@ -0,0 +1,24 @@ +getIO(); + $this->composer = $event->getComposer(); + $fileSystem = new Filesystem(); + $pluginConfig = PluginConfig::load($this->composer, $io); + + $this->scriptDispatcher = $scriptDispatcher ?: new ScriptDispatcher($event); + $this->includeFile = $includeFile + ?: new IncludeFile( + $io, + $this->composer, + [ + new BaseDirToken($io, $pluginConfig), + new AppDirToken($io, $pluginConfig), + new WebDirToken($io, $pluginConfig), + new RootDirToken($io, $pluginConfig), + new ComposerModeToken($io, $pluginConfig), + ], + $fileSystem + ); + } + + public function preAutoloadDump() + { + if ($this->composer->getPackage()->getName() === 'typo3/cms') { + // Nothing to do typo3/cms is root package + return; + } + $this->includeFile->register(); + } + + public function postAutoloadDump() + { + $this->scriptDispatcher->executeScripts(); + } +} diff --git a/src/Plugin/Util/ExtensionKeyResolver.php b/src/Plugin/Util/ExtensionKeyResolver.php new file mode 100644 index 0000000..a728e12 --- /dev/null +++ b/src/Plugin/Util/ExtensionKeyResolver.php @@ -0,0 +1,49 @@ +getExtra(); + if (empty($extra['typo3/cms']['extension-key']) && str_starts_with($package->getType(), 'typo3-cms-')) { + // The only reason this is enforced, is to ease the transition of extensions of type "typo3-cms-*" + // Since the logic is removed how to derive the extension key from package name, we must enforce + // the extension key to be set to avoid ambiguity of the extension key between previous installers versions and this one + // e.g. package "foo/bar" previously was resolved to extension key "bar" and would now be resolved to "foo/bar" + // The only way to avoid this, is to enforce the deprecation and require an extension key to be set. + // This is important, as dependents of such extensions can reference paths using the key and this key must not + // differ from different versions of the composer installers package. + throw new \RuntimeException(sprintf('Extension with package name "%s" does not define an extension key.', $package->getName()), 1501195043); + } + + return $extra['typo3/cms']['extension-key'] ?? $package->getName(); + } +} diff --git a/tests/Plugin/Util/ExtensionKeyResolverTest.php b/tests/Plugin/Util/ExtensionKeyResolverTest.php new file mode 100644 index 0000000..96520de --- /dev/null +++ b/tests/Plugin/Util/ExtensionKeyResolverTest.php @@ -0,0 +1,83 @@ +setType($packageData['type']); + $package->setExtra($packageData['extra'] ?? []); + $extensionKey = ExtensionKeyResolver::resolve($package); + self::assertSame($expectedExtensionKey, $extensionKey); + } + + public static function resolveDataProvider(): \Generator + { + yield 'extension' => [ + 'packageData' => [ + 'name' => 'somevendor/somepackage-extension', + 'type' => 'typo3-cms-extension', + 'extra' => [ + 'typo3/cms' => [ + 'extension-key' => 'extension_with_key', + ], + ], + ], + 'expectedExtensionKey' => 'extension_with_key', + ]; + + yield 'composer package' => [ + 'packageData' => [ + 'name' => 'somevendor/somepackage-extension', + 'type' => 'library', + 'extra' => [ + 'typo3/cms' => [ + 'extension-key' => 'extension_with_key', + ], + ], + ], + 'expectedExtensionKey' => 'extension_with_key', + ]; + + yield 'composer package without extra' => [ + 'packageData' => [ + 'name' => 'somevendor/somepackage-extension', + 'type' => 'library', + ], + 'expectedExtensionKey' => 'somevendor/somepackage-extension', + ]; + } + + #[Test] + public function extensionKeyResolvingThrowsExceptionIfKeyNotSetInExtra(): void + { + $this->expectException(\RuntimeException::class); + $package = new Package('foo/bar', 'dev-develop', 'dev-develop'); + $package->setType('typo3-cms-extension'); + ExtensionKeyResolver::resolve($package); + } +}