File manager - Edit - /home/opticamezl/www/newok/console.tar
Back
LICENSE 0000644 00000042630 15173302121 0005551 0 ustar 00 GNU GENERAL PUBLIC LICENSE Version 2, June 1991 Copyright (C) 1989, 1991 Free Software Foundation, Inc. 59 Temple Place, Suite 330, Boston, MA 02111-1307 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 Library 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. <one line to give the program's name and a brief idea of what it does.> Copyright (C) <year> <name of author> 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 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. <signature of Ty Coon>, 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 Library General Public License instead of this License. src/Event/ApplicationErrorEvent.php 0000644 00000004374 15173302121 0013407 0 ustar 00 <?php /** * Part of the Joomla Framework Console Package * * @copyright Copyright (C) 2005 - 2021 Open Source Matters, Inc. All rights reserved. * @license GNU General Public License version 2 or later; see LICENSE */ namespace Joomla\Console\Event; use Joomla\Console\Application; use Joomla\Console\Command\AbstractCommand; use Joomla\Console\ConsoleEvents; /** * Event triggered when an uncaught Throwable is received by the application. * * @since 2.0.0 */ class ApplicationErrorEvent extends ConsoleEvent { /** * The Throwable object with the error data. * * @var \Throwable * @since 2.0.0 */ private $error; /** * The exit code to use for the application. * * @var integer|null * @since 2.0.0 */ private $exitCode; /** * Event constructor. * * @param \Throwable $error The Throwable object with the error data. * @param Application $application The active application. * @param AbstractCommand|null $command The command being executed. * * @since 2.0.0 */ public function __construct(\Throwable $error, Application $application, ?AbstractCommand $command = null) { parent::__construct(ConsoleEvents::APPLICATION_ERROR, $application, $command); $this->error = $error; } /** * Get the error object. * * @return \Throwable * * @since 2.0.0 */ public function getError(): \Throwable { return $this->error; } /** * Gets the exit code. * * @return integer * * @since 2.0.0 */ public function getExitCode(): int { return $this->exitCode ?: (\is_int($this->error->getCode()) && $this->error->getCode() !== 0 ? $this->error->getCode() : 1); } /** * Set the error object. * * @param \Throwable $error The error object to set to the event. * * @return void * * @since 2.0.0 */ public function setError(\Throwable $error): void { $this->error = $error; } /** * Sets the exit code. * * @param integer $exitCode The command exit code. * * @return void * * @since 2.0.0 */ public function setExitCode(int $exitCode): void { $this->exitCode = $exitCode; $r = new \ReflectionProperty($this->error, 'code'); $r->setAccessible(true); $r->setValue($this->error, $this->exitCode); } } src/Event/CommandErrorEvent.php 0000644 00000004462 15173302121 0012520 0 ustar 00 <?php /** * Part of the Joomla Framework Console Package * * @copyright Copyright (C) 2005 - 2021 Open Source Matters, Inc. All rights reserved. * @license GNU General Public License version 2 or later; see LICENSE */ namespace Joomla\Console\Event; use Joomla\Console\Application; use Joomla\Console\Command\AbstractCommand; use Joomla\Console\ConsoleEvents; /** * Event triggered when an uncaught Throwable is received by the application from a command. * * @since 2.0.0 */ class CommandErrorEvent extends ConsoleEvent { /** * The Throwable object with the error data. * * @var \Throwable * @since 2.0.0 */ private $error; /** * The exit code to use for the application. * * @var integer|null * @since 2.0.0 */ private $exitCode; /** * Event constructor. * * @param \Throwable $error The Throwable object with the error data. * @param Application $application The active application. * @param AbstractCommand|null $command The command being executed. * * @since 2.0.0 */ public function __construct(\Throwable $error, Application $application, ?AbstractCommand $command = null) { parent::__construct(ConsoleEvents::COMMAND_ERROR, $application, $command); $this->error = $error; } /** * Get the error object. * * @return \Throwable * * @since 2.0.0 */ public function getError(): \Throwable { return $this->error; } /** * Gets the exit code. * * @return integer * * @since 2.0.0 */ public function getExitCode(): int { if ($this->exitCode !== null) { return $this->exitCode; } return \is_int($this->error->getCode()) && $this->error->getCode() !== 0 ? $this->error->getCode() : 1; } /** * Set the error object. * * @param \Throwable $error The error object to set to the event. * * @return void * * @since 2.0.0 */ public function setError(\Throwable $error): void { $this->error = $error; } /** * Sets the exit code. * * @param integer $exitCode The command exit code. * * @return void * * @since 2.0.0 */ public function setExitCode(int $exitCode): void { $this->exitCode = $exitCode; $r = new \ReflectionProperty($this->error, 'code'); $r->setAccessible(true); $r->setValue($this->error, $this->exitCode); } } src/Event/TerminateEvent.php 0000644 00000002764 15173302121 0012063 0 ustar 00 <?php /** * Part of the Joomla Framework Console Package * * @copyright Copyright (C) 2005 - 2021 Open Source Matters, Inc. All rights reserved. * @license GNU General Public License version 2 or later; see LICENSE */ namespace Joomla\Console\Event; use Joomla\Console\Application; use Joomla\Console\Command\AbstractCommand; use Joomla\Console\ConsoleEvents; /** * Event triggered immediately before the process is terminated. * * @since 2.0.0 */ class TerminateEvent extends ConsoleEvent { /** * The exit code to use for the application. * * @var integer * @since 2.0.0 */ private $exitCode; /** * Event constructor. * * @param integer $exitCode The Throwable object with the error data. * @param Application $application The active application. * @param AbstractCommand|null $command The command being executed. * * @since 2.0.0 */ public function __construct(int $exitCode, Application $application, ?AbstractCommand $command = null) { parent::__construct(ConsoleEvents::TERMINATE, $application, $command); $this->exitCode = $exitCode; } /** * Gets the exit code. * * @return integer * * @since 2.0.0 */ public function getExitCode(): int { return $this->exitCode; } /** * Sets the exit code. * * @param integer $exitCode The command exit code. * * @return void * * @since 2.0.0 */ public function setExitCode(int $exitCode): void { $this->exitCode = $exitCode; } } src/Event/ConsoleEvent.php 0000644 00000003005 15173302121 0011522 0 ustar 00 <?php /** * Part of the Joomla Framework Console Package * * @copyright Copyright (C) 2005 - 2021 Open Source Matters, Inc. All rights reserved. * @license GNU General Public License version 2 or later; see LICENSE */ namespace Joomla\Console\Event; use Joomla\Console\Application; use Joomla\Console\Command\AbstractCommand; use Joomla\Event\Event; /** * Base event class for console events. * * @since 2.0.0 */ class ConsoleEvent extends Event { /** * The active application. * * @var Application * @since 2.0.0 */ private $application; /** * The command being executed. * * @var AbstractCommand|null * @since 2.0.0 */ private $command; /** * Event constructor. * * @param string $name The event name. * @param Application $application The active application. * @param AbstractCommand|null $command The command being executed. * * @since 2.0.0 */ public function __construct(string $name, Application $application, ?AbstractCommand $command = null) { parent::__construct($name); $this->application = $application; $this->command = $command; } /** * Get the active application. * * @return Application * * @since 2.0.0 */ public function getApplication(): Application { return $this->application; } /** * Get the command being executed. * * @return AbstractCommand|null * * @since 2.0.0 */ public function getCommand(): ?AbstractCommand { return $this->command; } } src/Event/BeforeCommandExecuteEvent.php 0000644 00000003326 15173302121 0014152 0 ustar 00 <?php /** * Part of the Joomla Framework Console Package * * @copyright Copyright (C) 2005 - 2021 Open Source Matters, Inc. All rights reserved. * @license GNU General Public License version 2 or later; see LICENSE */ namespace Joomla\Console\Event; use Joomla\Console\Application; use Joomla\Console\Command\AbstractCommand; use Joomla\Console\ConsoleEvents; /** * Event triggered before a command is executed. * * @since 2.0.0 */ class BeforeCommandExecuteEvent extends ConsoleEvent { /** * The return code for a command disabled by this event. * * @var integer * @since 2.0.0 */ public const RETURN_CODE_DISABLED = 113; /** * Flag indicating the command is enabled * * @var boolean * @since 2.0.0 */ private $commandEnabled = true; /** * Event constructor. * * @param Application $application The active application. * @param AbstractCommand|null $command The command being executed. * * @since 2.0.0 */ public function __construct(Application $application, ?AbstractCommand $command = null) { parent::__construct(ConsoleEvents::BEFORE_COMMAND_EXECUTE, $application, $command); if ($command) { $this->commandEnabled = $command->isEnabled(); } } /** * Disable the command. * * @return void * * @since 2.0.0 */ public function disableCommand(): void { $this->commandEnabled = false; } /** * Enable the command. * * @return void * * @since 2.0.0 */ public function enableCommand(): void { $this->commandEnabled = false; } /** * Check if the command is enabled. * * @return boolean * * @since 2.0.0 */ public function isCommandEnabled(): bool { return $this->commandEnabled; } } src/ConsoleEvents.php 0000644 00000003135 15173302121 0010630 0 ustar 00 <?php /** * Part of the Joomla Framework Console Package * * @copyright Copyright (C) 2005 - 2021 Open Source Matters, Inc. All rights reserved. * @license GNU General Public License version 2 or later; see LICENSE */ namespace Joomla\Console; /** * Class defining the events available in the console application. * * @since 2.0.0 */ final class ConsoleEvents { /** * The APPLICATION_ERROR event is an event triggered when an uncaught Throwable is received at the main application executor. * * This event allows developers to handle the Throwable. * * @var string * @since 2.0.0 */ public const APPLICATION_ERROR = 'console.application_error'; /** * The BEFORE_COMMAND_EXECUTE event is an event triggered before a command is executed. * * This event allows developers to modify information about the command or the command's * dependencies prior to the command being executed. * * @var string * @since 2.0.0 */ public const BEFORE_COMMAND_EXECUTE = 'console.before_command_execute'; /** * The COMMAND_ERROR event is an event triggered when an uncaught Throwable from a command is received. * * This event allows developers to handle the Throwable. * * @var string * @since 2.0.0 */ public const COMMAND_ERROR = 'console.command_error'; /** * The TERMINATE event is an event triggered immediately before the application is exited. * * This event allows developers to perform any post-process actions and to manipulate * the process' exit code. * * @var string * @since 2.0.0 */ public const TERMINATE = 'console.terminate'; } src/Helper/DescriptorHelper.php 0000644 00000002151 15173302121 0012533 0 ustar 00 <?php /** * Part of the Joomla Framework Console Package * * @copyright Copyright (C) 2005 - 2021 Open Source Matters, Inc. All rights reserved. * @license GNU General Public License version 2 or later; see LICENSE */ namespace Joomla\Console\Helper; use Joomla\Console\Descriptor\TextDescriptor; use Symfony\Component\Console\Helper\Helper; use Symfony\Component\Console\Output\OutputInterface; /** * Describes an object. * * @since 2.0.0 */ class DescriptorHelper extends Helper { /** * Describes an object if supported. * * @param OutputInterface $output The output object to use. * @param object $object The object to describe. * @param array $options Options for the descriptor. * * @return void * * @since _2.0.0 */ public function describe(OutputInterface $output, $object, array $options = []) { (new TextDescriptor)->describe($output, $object, $options); } /** * Returns the canonical name of this helper. * * @return string The canonical name * * @since _2.0.0 */ public function getName() { return 'descriptor'; } } src/Descriptor/ApplicationDescription.php 0000644 00000011567 15173302121 0014636 0 ustar 00 <?php /** * Part of the Joomla Framework Console Package * * @copyright Copyright (C) 2005 - 2021 Open Source Matters, Inc. All rights reserved. * @license GNU General Public License version 2 or later; see LICENSE */ namespace Joomla\Console\Descriptor; use Joomla\Console\Application; use Joomla\Console\Command\AbstractCommand; use Symfony\Component\Console\Exception\CommandNotFoundException; /** * Describes an application. * * @since 2.0.0 */ final class ApplicationDescription { /** * Placeholder for commands in the global namespace. * * @var string * @since 2.0.0 */ public const GLOBAL_NAMESPACE = '_global'; /** * The application's aliased commands. * * @var AbstractCommand[] * @since 2.0.0 */ private $aliases; /** * The application being described. * * @var Application * @since 2.0.0 */ private $application; /** * The application's commands. * * @var AbstractCommand[] * @since 2.0.0 */ private $commands; /** * The command namespace to process. * * @var string * @since 2.0.0 */ private $namespace = ''; /** * The application's command namespaces. * * @var array[] * @since 2.0.0 */ private $namespaces; /** * Flag indicating hidden commands should be displayed. * * @var boolean * @since 2.0.0 */ private $showHidden; /** * Constructor. * * @param Application $application The application being described. * @param string $namespace The command namespace to process. * @param boolean $showHidden Flag indicating hidden commands should be displayed. * * @since 2.0.0 */ public function __construct(Application $application, string $namespace = '', bool $showHidden = false) { $this->application = $application; $this->namespace = $namespace; $this->showHidden = $showHidden; } /** * Get the application's command namespaces. * * @return array[] * * @since 2.0.0 */ public function getNamespaces(): array { if ($this->namespaces === null) { $this->inspectApplication(); } return $this->namespaces; } /** * Get the application's commands. * * @return AbstractCommand[] * * @since 2.0.0 */ public function getCommands(): array { if ($this->commands === null) { $this->inspectApplication(); } return $this->commands; } /** * Get a command by name. * * @param string $name The name of the command to retrieve. * * @return AbstractCommand * * @since 2.0.0 * @throws CommandNotFoundException */ public function getCommand(string $name): AbstractCommand { if (!isset($this->commands[$name]) && !isset($this->aliases[$name])) { throw new CommandNotFoundException(sprintf('Command %s does not exist.', $name)); } return $this->commands[$name] ?? $this->aliases[$name]; } /** * Returns the namespace part of the command name. * * @param string $name The command name to process * @param integer $limit The maximum number of parts of the namespace * * @return string * * @since 2.0.0 */ private function extractNamespace(string $name, ?int $limit = null): string { $parts = explode(':', $name); array_pop($parts); return implode(':', $limit === null ? $parts : \array_slice($parts, 0, $limit)); } /** * Inspects the application. * * @return void * * @since 2.0.0 */ private function inspectApplication(): void { $this->commands = []; $this->namespaces = []; $all = $this->application->getAllCommands($this->namespace ? $this->application->findNamespace($this->namespace) : ''); foreach ($this->sortCommands($all) as $namespace => $commands) { $names = []; foreach ($commands as $name => $command) { if (!$command->getName() || (!$this->showHidden && $command->isHidden())) { continue; } if ($command->getName() === $name) { $this->commands[$name] = $command; } else { $this->aliases[$name] = $command; } $names[] = $name; } $this->namespaces[$namespace] = ['id' => $namespace, 'commands' => $names]; } } /** * Sort a set of commands. * * @param AbstractCommand[] $commands The commands to sort. * * @return AbstractCommand[][] * * @since 2.0.0 */ private function sortCommands(array $commands): array { $namespacedCommands = []; $globalCommands = []; foreach ($commands as $name => $command) { $key = $this->extractNamespace($name, 1); if (!$key) { $globalCommands[self::GLOBAL_NAMESPACE][$name] = $command; } else { $namespacedCommands[$key][$name] = $command; } } ksort($namespacedCommands); $namespacedCommands = array_merge($globalCommands, $namespacedCommands); foreach ($namespacedCommands as &$commandsSet) { ksort($commandsSet); } // Unset reference to keep scope clear unset($commandsSet); return $namespacedCommands; } } src/Descriptor/TextDescriptor.php 0000644 00000015226 15173302121 0013146 0 ustar 00 <?php /** * Part of the Joomla Framework Console Package * * @copyright Copyright (C) 2005 - 2021 Open Source Matters, Inc. All rights reserved. * @license GNU General Public License version 2 or later; see LICENSE */ namespace Joomla\Console\Descriptor; use Joomla\Console\Application; use Joomla\Console\Command\AbstractCommand; use Joomla\String\StringHelper; use Symfony\Component\Console\Descriptor\TextDescriptor as SymfonyTextDescriptor; use Symfony\Component\Console\Input\InputDefinition; use Symfony\Component\Console\Output\OutputInterface; /** * Text object descriptor. * * @since 2.0.0 */ final class TextDescriptor extends SymfonyTextDescriptor { /** * Describes an object. * * @param OutputInterface $output The output object to use. * @param object $object The object to describe. * @param array $options Descriptor options. * * @return void * * @since 2.0.0 */ public function describe(OutputInterface $output, $object, array $options = []) { $this->output = $output; switch (true) { case $object instanceof Application: $this->describeJoomlaApplication($object, $options); break; case $object instanceof AbstractCommand: $this->describeConsoleCommand($object, $options); break; default: parent::describe($output, $object, $options); } } /** * Formats command aliases to show them in the command description. * * @param AbstractCommand $command The command to process * * @return string * * @since 2.0.0 */ private function getCommandAliasesText(AbstractCommand $command): string { $text = ''; $aliases = $command->getAliases(); if ($aliases) { $text = '[' . implode('|', $aliases) . '] '; } return $text; } /** * Describes a command. * * @param AbstractCommand $command The command being described. * @param array $options Descriptor options. * * @return void * * @since 2.0.0 */ private function describeConsoleCommand(AbstractCommand $command, array $options): void { $command->getSynopsis(true); $command->getSynopsis(false); $command->mergeApplicationDefinition(false); $this->writeText('<comment>Usage:</comment>', $options); foreach (array_merge([$command->getSynopsis(true)], $command->getAliases()) as $usage) { $this->writeText("\n"); $this->writeText(' ' . $usage, $options); } $this->writeText("\n"); $definition = $command->getDefinition(); if ($definition->getOptions() || $definition->getArguments()) { $this->writeText("\n"); $this->describeInputDefinition($definition, $options); $this->writeText("\n"); } if ($help = $command->getProcessedHelp()) { $this->writeText("\n"); $this->writeText('<comment>Help:</comment>', $options); $this->writeText("\n"); $this->writeText(' ' . str_replace("\n", "\n ", $help), $options); $this->writeText("\n"); } } /** * Describes an application. * * @param Application $app The application being described. * @param array $options Descriptor options. * * @return void * * @since 2.0.0 */ private function describeJoomlaApplication(Application $app, array $options): void { $describedNamespace = $options['namespace'] ?? ''; $description = new ApplicationDescription($app, $describedNamespace); $version = $app->getLongVersion(); if ($version !== '') { $this->writeText("$version\n\n", $options); } $this->writeText("<comment>Usage:</comment>\n"); $this->writeText(" command [options] [arguments]\n\n"); $this->describeInputDefinition(new InputDefinition($app->getDefinition()->getOptions()), $options); $this->writeText("\n"); $this->writeText("\n"); $commands = $description->getCommands(); $namespaces = $description->getNamespaces(); if ($describedNamespace && $namespaces) { // Ensure all aliased commands are included when describing a specific namespace $describedNamespaceInfo = reset($namespaces); foreach ($describedNamespaceInfo['commands'] as $name) { $commands[$name] = $description->getCommand($name); } } $width = $this->getColumnWidth( \call_user_func_array( 'array_merge', array_map( function ($namespace) use ($commands) { return array_intersect($namespace['commands'], array_keys($commands)); }, array_values($namespaces) ) ) ); if ($describedNamespace) { $this->writeText(sprintf('<comment>Available commands for the "%s" namespace:</comment>', $describedNamespace), $options); } else { $this->writeText('<comment>Available commands:</comment>', $options); } foreach ($namespaces as $namespace) { $namespace['commands'] = array_filter( $namespace['commands'], function ($name) use ($commands) { return isset($commands[$name]); } ); if (!$namespace['commands']) { continue; } if (!$describedNamespace && $namespace['id'] !== ApplicationDescription::GLOBAL_NAMESPACE) { $this->writeText("\n"); $this->writeText(' <comment>' . $namespace['id'] . '</comment>', $options); } foreach ($namespace['commands'] as $name) { $this->writeText("\n"); $spacingWidth = $width - StringHelper::strlen($name); $command = $commands[$name]; $commandAliases = $name === $command->getName() ? $this->getCommandAliasesText($command) : ''; $this->writeText( sprintf( ' <info>%s</info>%s%s', $name, str_repeat(' ', $spacingWidth), $commandAliases . $command->getDescription() ), $options ); } } $this->writeText("\n"); } /** * Calculate the column width for a group of commands. * * @param AbstractCommand[]|string[] $commands The commands to use for processing a width. * * @return integer * * @since 2.0.0 */ private function getColumnWidth(array $commands): int { $widths = []; foreach ($commands as $command) { if ($command instanceof AbstractCommand) { $widths[] = StringHelper::strlen($command->getName()); foreach ($command->getAliases() as $alias) { $widths[] = StringHelper::strlen($alias); } } else { $widths[] = StringHelper::strlen($command); } } return $widths ? max($widths) + 2 : 0; } /** * Writes text to the output. * * @param string $content The message. * @param array $options The options to use for formatting the output. * * @return void * * @since 2.0.0 */ private function writeText($content, array $options = []): void { $this->write( isset($options['raw_text']) && $options['raw_text'] ? strip_tags($content) : $content, isset($options['raw_output']) ? !$options['raw_output'] : true ); } } src/Command/ListCommand.php 0000644 00000003376 15173302121 0011640 0 ustar 00 <?php /** * Part of the Joomla Framework Console Package * * @copyright Copyright (C) 2005 - 2021 Open Source Matters, Inc. All rights reserved. * @license GNU General Public License version 2 or later; see LICENSE */ namespace Joomla\Console\Command; use Joomla\Console\Helper\DescriptorHelper; use Symfony\Component\Console\Input\InputArgument; use Symfony\Component\Console\Input\InputInterface; use Symfony\Component\Console\Output\OutputInterface; /** * Command listing all available commands. * * @since 2.0.0 */ class ListCommand extends AbstractCommand { /** * The default command name * * @var string * @since 2.0.0 */ protected static $defaultName = 'list'; /** * Configure the command. * * @return void * * @since 2.0.0 */ protected function configure(): void { $this->setDescription("List the application's available commands"); $this->addArgument('namespace', InputArgument::OPTIONAL, 'The namespace name'); $this->setHelp(<<<'EOF' The <info>%command.name%</info> command lists all of the application's commands: <info>php %command.full_name%</info> EOF ); } /** * Internal function to execute the command. * * @param InputInterface $input The input to inject into the command. * @param OutputInterface $output The output to inject into the command. * * @return integer The command exit code * * @since 2.0.0 */ protected function doExecute(InputInterface $input, OutputInterface $output): int { $descriptor = new DescriptorHelper; if ($this->getHelperSet() !== null) { $this->getHelperSet()->set($descriptor); } $descriptor->describe( $output, $this->getApplication(), [ 'namespace' => $input->getArgument('namespace'), ] ); return 0; } } src/Command/HelpCommand.php 0000644 00000004415 15173302121 0011610 0 ustar 00 <?php /** * Part of the Joomla Framework Console Package * * @copyright Copyright (C) 2005 - 2021 Open Source Matters, Inc. All rights reserved. * @license GNU General Public License version 2 or later; see LICENSE */ namespace Joomla\Console\Command; use Joomla\Console\Helper\DescriptorHelper; use Symfony\Component\Console\Input\InputArgument; use Symfony\Component\Console\Input\InputInterface; use Symfony\Component\Console\Output\OutputInterface; /** * Command to render a command's help data. * * @since 2.0.0 */ class HelpCommand extends AbstractCommand { /** * The default command name * * @var string * @since 2.0.0 */ protected static $defaultName = 'help'; /** * The command to process help for * * @var AbstractCommand|null * @since 2.0.0 */ private $command; /** * Configure the command. * * @return void * * @since 2.0.0 */ protected function configure(): void { $this->setDescription('Show the help for a command'); $this->setHelp(<<<'EOF' The <info>%command.name%</info> command displays a command's help information: <info>php %command.full_name% list</info> To display the list of available commands, please use the <info>list</info> command. EOF ); $this->addArgument('command_name', InputArgument::OPTIONAL, 'The command name', 'help'); } /** * Internal function to execute the command. * * @param InputInterface $input The input to inject into the command. * @param OutputInterface $output The output to inject into the command. * * @return integer The command exit code * * @since 2.0.0 */ protected function doExecute(InputInterface $input, OutputInterface $output): int { if (!$this->command) { $this->command = $this->getApplication()->getCommand($input->getArgument('command_name')); } $descriptor = new DescriptorHelper; if ($this->getHelperSet() !== null) { $this->getHelperSet()->set($descriptor); } $descriptor->describe($output, $this->command); return 0; } /** * Set the command whose help is being presented. * * @param AbstractCommand $command The command to process help for. * * @return void * * @since 2.0.0 */ public function setCommand(AbstractCommand $command): void { $this->command = $command; } } src/Command/AbstractCommand.php 0000644 00000030645 15173302121 0012467 0 ustar 00 <?php /** * Part of the Joomla Framework Console Package * * @copyright Copyright (C) 2005 - 2021 Open Source Matters, Inc. All rights reserved. * @license GNU General Public License version 2 or later; see LICENSE */ namespace Joomla\Console\Command; use Joomla\Console\Application; use Symfony\Component\Console\Helper\HelperSet; use Symfony\Component\Console\Input\InputArgument; use Symfony\Component\Console\Input\InputDefinition; use Symfony\Component\Console\Input\InputInterface; use Symfony\Component\Console\Input\InputOption; use Symfony\Component\Console\Output\OutputInterface; /** * Base command class for a Joomla! command line application. * * @since 2.0.0 */ abstract class AbstractCommand { /** * The default command name * * @var string|null * @since 2.0.0 */ protected static $defaultName; /** * The command's aliases. * * @var string[] * @since 2.0.0 */ private $aliases = []; /** * The application running this command. * * @var Application|null * @since 2.0.0 */ private $application; /** * Flag tracking whether the application definition has been merged to this command. * * @var boolean * @since 2.0.0 */ private $applicationDefinitionMerged = false; /** * Flag tracking whether the application definition with arguments has been merged to this command. * * @var boolean * @since 2.0.0 */ private $applicationDefinitionMergedWithArgs = false; /** * The command's input definition. * * @var InputDefinition * @since 2.0.0 */ private $definition; /** * The command's description. * * @var string * @since 2.0.0 */ private $description = ''; /** * The command's help. * * @var string * @since 2.0.0 */ private $help = ''; /** * The command's input helper set. * * @var HelperSet|null * @since 2.0.0 */ private $helperSet; /** * Flag tracking whether the command is hidden from the command listing. * * @var boolean * @since 2.0.0 */ private $hidden = false; /** * The command's name. * * @var string * @since 2.0.0 */ private $name; /** * The command's synopses. * * @var string[] * @since 2.0.0 */ private $synopsis = []; /** * Command constructor. * * @param string|null $name The name of the command; if the name is empty and no default is set, a name must be set in the configure() method * * @since 2.0.0 */ public function __construct(?string $name = null) { $this->definition = new InputDefinition; if ($name !== null || null !== $name = static::getDefaultName()) { $this->setName($name); } $this->configure(); } /** * Adds an argument to the input definition. * * @param string $name The argument name * @param integer $mode The argument mode: InputArgument::REQUIRED or InputArgument::OPTIONAL * @param string $description A description text * @param mixed $default The default value (for InputArgument::OPTIONAL mode only) * * @return $this * * @since 2.0.0 */ public function addArgument(string $name, ?int $mode = null, string $description = '', $default = null): self { $this->definition->addArgument(new InputArgument($name, $mode, $description, $default)); return $this; } /** * Adds an option to the input definition. * * @param string $name The option name * @param string|array $shortcut The shortcuts, can be null, a string of shortcuts delimited by | or an array of shortcuts * @param integer $mode The option mode: One of the VALUE_* constants * @param string $description A description text * @param mixed $default The default value (must be null for InputOption::VALUE_NONE) * * @return $this * * @since 2.0.0 */ public function addOption(string $name, $shortcut = null, ?int $mode = null, $description = '', $default = null): self { $this->definition->addOption(new InputOption($name, $shortcut, $mode, $description, $default)); return $this; } /** * Configure the command. * * @return void * * @since 2.0.0 */ protected function configure(): void { } /** * Internal function to execute the command. * * @param InputInterface $input The input to inject into the command. * @param OutputInterface $output The output to inject into the command. * * @return integer The command exit code * * @since 2.0.0 */ abstract protected function doExecute(InputInterface $input, OutputInterface $output): int; /** * Executes the command. * * @param InputInterface $input The input to inject into the command. * @param OutputInterface $output The output to inject into the command. * * @return integer The command exit code * * @since 2.0.0 */ public function execute(InputInterface $input, OutputInterface $output): int { // Force the creation of the synopsis before the merge with the app definition $this->getSynopsis(true); $this->getSynopsis(false); // Add the application arguments and options $this->mergeApplicationDefinition(); // Bind the input against the command specific arguments/options $input->bind($this->getDefinition()); $this->initialise($input, $output); // Ensure that the command has a `command` argument so it does not fail validation if ($input->hasArgument('command') && $input->getArgument('command') === null) { $input->setArgument('command', $this->getName()); } $input->validate(); return $this->doExecute($input, $output); } /** * Get the command's aliases. * * @return string[] * * @since 2.0.0 */ public function getAliases(): array { return $this->aliases; } /** * Get the application object. * * @return Application The application object. * * @since 2.0.0 * @throws \UnexpectedValueException if the application has not been set. */ public function getApplication(): Application { if ($this->application) { return $this->application; } throw new \UnexpectedValueException('Application not set in ' . \get_class($this)); } /** * Get the default command name for this class. * * This allows a command name to defined and referenced without instantiating the full command class. * * @return string|null * * @since 2.0.0 */ public static function getDefaultName(): ?string { $class = \get_called_class(); $r = new \ReflectionProperty($class, 'defaultName'); return $class === $r->class ? static::$defaultName : null; } /** * Gets the InputDefinition attached to this command. * * @return InputDefinition * * @since 2.0.0 */ public function getDefinition(): InputDefinition { return $this->definition; } /** * Get the command's description. * * @return string * * @since 2.0.0 */ public function getDescription(): string { return $this->description; } /** * Get the command's help. * * @return string * * @since 2.0.0 */ public function getHelp(): string { return $this->help; } /** * Get the command's input helper set. * * @return HelperSet|null * * @since 2.0.0 */ public function getHelperSet(): ?HelperSet { return $this->helperSet; } /** * Get the command's name. * * @return string|null * * @since 2.0.0 */ public function getName(): ?string { return $this->name; } /** * Returns the processed help for the command. * * This method is used to replace placeholders in commands with the real values. * By default, this supports `%command.name%` and `%command.full_name`. * * @return string * * @since 2.0.0 */ public function getProcessedHelp(): string { $name = $this->getName(); $placeholders = [ '%command.name%', '%command.full_name%', ]; $replacements = [ $name, $_SERVER['PHP_SELF'] . ' ' . $name, ]; return str_replace($placeholders, $replacements, $this->getHelp() ?: $this->getDescription()); } /** * Get the command's synopsis. * * @param boolean $short Flag indicating whether the short or long version of the synopsis should be returned * * @return string * * @since 2.0.0 */ public function getSynopsis(bool $short = false): string { $key = $short ? 'short' : 'long'; if (!isset($this->synopsis[$key])) { $this->synopsis[$key] = trim(sprintf('%s %s', $this->getName(), $this->getDefinition()->getSynopsis($short))); } return $this->synopsis[$key]; } /** * Internal hook to initialise the command after the input has been bound and before the input is validated. * * @param InputInterface $input The input to inject into the command. * @param OutputInterface $output The output to inject into the command. * * @return void * * @since 2.0.0 */ protected function initialise(InputInterface $input, OutputInterface $output): void { } /** * Check if the command is enabled in this environment. * * @return boolean * * @since 2.0.0 */ public function isEnabled(): bool { return true; } /** * Check if the command is hidden from the command listing. * * @return boolean * * @since 2.0.0 */ public function isHidden(): bool { return $this->hidden; } /** * Merges the application definition with the command definition. * * @param boolean $mergeArgs Flag indicating whether the application's definition arguments should be merged * * @return void * * @since 2.0.0 * @internal This method should not be relied on as part of the public API */ final public function mergeApplicationDefinition(bool $mergeArgs = true): void { if (!$this->application || ($this->applicationDefinitionMerged && ($this->applicationDefinitionMergedWithArgs || !$mergeArgs))) { return; } $this->getDefinition()->addOptions($this->getApplication()->getDefinition()->getOptions()); $this->applicationDefinitionMerged = true; if ($mergeArgs) { $currentArguments = $this->getDefinition()->getArguments(); $this->getDefinition()->setArguments($this->getApplication()->getDefinition()->getArguments()); $this->getDefinition()->addArguments($currentArguments); $this->applicationDefinitionMergedWithArgs = true; } } /** * Set the command's aliases. * * @param string[] $aliases The command aliases * * @return void * * @since 2.0.0 */ public function setAliases(array $aliases): void { $this->aliases = $aliases; } /** * Set the command's application. * * @param Application $application The command's application * * @return void * * @since 2.0.0 */ public function setApplication(?Application $application = null): void { $this->application = $application; if ($application) { $this->setHelperSet($application->getHelperSet()); } else { $this->helperSet = null; } } /** * Sets the input definition for the command. * * @param array|InputDefinition $definition Either an InputDefinition object or an array of objects to write to the definition. * * @return void * * @since 2.0.0 */ public function setDefinition($definition): void { if ($definition instanceof InputDefinition) { $this->definition = $definition; } else { $this->definition->setDefinition($definition); } $this->applicationDefinitionMerged = false; } /** * Sets the description for the command. * * @param string $description The description for the command * * @return void * * @since 2.0.0 */ public function setDescription(string $description): void { $this->description = $description; } /** * Sets the help for the command. * * @param string $help The help for the command * * @return void * * @since 2.0.0 */ public function setHelp(string $help): void { $this->help = $help; } /** * Set the command's input helper set. * * @param HelperSet $helperSet The helper set. * * @return void * * @since 2.0.0 */ public function setHelperSet(HelperSet $helperSet): void { $this->helperSet = $helperSet; } /** * Set whether this command is hidden from the command listing. * * @param boolean $hidden Flag if this command is hidden. * * @return void * * @since 2.0.0 */ public function setHidden(bool $hidden): void { $this->hidden = $hidden; } /** * Set the command's name. * * @param string $name The command name * * @return void * * @since 2.0.0 */ public function setName(string $name): void { $this->name = $name; } } src/Exception/NamespaceNotFoundException.php 0000644 00000000743 15173302121 0015231 0 ustar 00 <?php /** * Part of the Joomla Framework Console Package * * @copyright Copyright (C) 2005 - 2021 Open Source Matters, Inc. All rights reserved. * @license GNU General Public License version 2 or later; see LICENSE */ namespace Joomla\Console\Exception; use Symfony\Component\Console\Exception\CommandNotFoundException; /** * Exception indicating a missing command namespace. * * @since 2.0.0 */ class NamespaceNotFoundException extends CommandNotFoundException { } src/Application.php 0000644 00000100525 15173302121 0010305 0 ustar 00 <?php /** * Part of the Joomla Framework Console Package * * @copyright Copyright (C) 2005 - 2021 Open Source Matters, Inc. All rights reserved. * @license GNU General Public License version 2 or later; see LICENSE */ namespace Joomla\Console; use Joomla\Application\AbstractApplication; use Joomla\Application\ApplicationEvents; use Joomla\Console\Command\AbstractCommand; use Joomla\Console\Command\HelpCommand; use Joomla\Console\Event\ApplicationErrorEvent; use Joomla\Console\Event\BeforeCommandExecuteEvent; use Joomla\Console\Event\CommandErrorEvent; use Joomla\Console\Event\TerminateEvent; use Joomla\Console\Exception\NamespaceNotFoundException; use Joomla\Registry\Registry; use Joomla\String\StringHelper; use Symfony\Component\Console\Exception\CommandNotFoundException; use Symfony\Component\Console\Exception\ExceptionInterface; use Symfony\Component\Console\Exception\LogicException; use Symfony\Component\Console\Formatter\OutputFormatter; use Symfony\Component\Console\Helper\DebugFormatterHelper; use Symfony\Component\Console\Helper\FormatterHelper; use Symfony\Component\Console\Helper\HelperSet; use Symfony\Component\Console\Helper\ProcessHelper; use Symfony\Component\Console\Helper\QuestionHelper; use Symfony\Component\Console\Input\ArgvInput; use Symfony\Component\Console\Input\ArrayInput; use Symfony\Component\Console\Input\InputArgument; use Symfony\Component\Console\Input\InputAwareInterface; use Symfony\Component\Console\Input\InputDefinition; use Symfony\Component\Console\Input\InputInterface; use Symfony\Component\Console\Input\InputOption; use Symfony\Component\Console\Output\ConsoleOutput; use Symfony\Component\Console\Output\ConsoleOutputInterface; use Symfony\Component\Console\Output\OutputInterface; use Symfony\Component\Console\Style\SymfonyStyle; use Symfony\Component\Console\Terminal; use Symfony\Component\ErrorHandler\ErrorHandler; /** * Base application class for a Joomla! command line application. * * @since 2.0.0 */ class Application extends AbstractApplication { /** * Flag indicating the application should automatically exit after the command is run. * * @var boolean * @since 2.0.0 */ private $autoExit = true; /** * Flag indicating the application should catch and handle Throwables. * * @var boolean * @since 2.0.0 */ private $catchThrowables = true; /** * The available commands. * * @var AbstractCommand[] * @since 2.0.0 */ private $commands = []; /** * The command loader. * * @var Loader\LoaderInterface|null * @since 2.0.0 */ private $commandLoader; /** * Console input handler. * * @var InputInterface * @since 2.0.0 */ private $consoleInput; /** * Console output handler. * * @var OutputInterface * @since 2.0.0 */ private $consoleOutput; /** * The default command for the application. * * @var string * @since 2.0.0 */ private $defaultCommand = 'list'; /** * The application input definition. * * @var InputDefinition|null * @since 2.0.0 */ private $definition; /** * The application helper set. * * @var HelperSet|null * @since 2.0.0 */ private $helperSet; /** * Internal flag tracking if the command store has been initialised. * * @var boolean * @since 2.0.0 */ private $initialised = false; /** * The name of the application. * * @var string * @since 2.0.0 */ private $name = ''; /** * Reference to the currently running command. * * @var AbstractCommand|null * @since 2.0.0 */ private $runningCommand; /** * The console terminal helper. * * @var Terminal * @since 2.0.0 */ private $terminal; /** * The version of the application. * * @var string * @since 2.0.0 */ private $version = ''; /** * Internal flag tracking if the user is seeking help for the given command. * * @var boolean * @since 2.0.0 */ private $wantsHelp = false; /** * Class constructor. * * @param InputInterface $input An optional argument to provide dependency injection for the application's input object. If the argument is * an InputInterface object that object will become the application's input object, otherwise a default input * object is created. * @param OutputInterface $output An optional argument to provide dependency injection for the application's output object. If the argument * is an OutputInterface object that object will become the application's output object, otherwise a default * output object is created. * @param Registry $config An optional argument to provide dependency injection for the application's config object. If the argument * is a Registry object that object will become the application's config object, otherwise a default config * object is created. * * @since 2.0.0 */ public function __construct(?InputInterface $input = null, ?OutputInterface $output = null, ?Registry $config = null) { // Close the application if we are not executed from the command line. if (!\defined('STDOUT') || !\defined('STDIN') || !isset($_SERVER['argv'])) { $this->close(); } $this->consoleInput = $input ?: new ArgvInput; $this->consoleOutput = $output ?: new ConsoleOutput; $this->terminal = new Terminal; // Call the constructor as late as possible (it runs `initialise`). parent::__construct($config); } /** * Adds a command object. * * If a command with the same name already exists, it will be overridden. If the command is not enabled it will not be added. * * @param AbstractCommand $command The command to add to the application. * * @return AbstractCommand * * @since 2.0.0 * @throws LogicException */ public function addCommand(AbstractCommand $command): AbstractCommand { $this->initCommands(); if (!$command->isEnabled()) { return $command; } $command->setApplication($this); try { $command->getDefinition(); } catch (\TypeError $exception) { throw new LogicException(sprintf('Command class "%s" is not correctly initialised.', \get_class($command)), 0, $exception); } if (!$command->getName()) { throw new LogicException(sprintf('The command class "%s" does not have a name.', \get_class($command))); } $this->commands[$command->getName()] = $command; foreach ($command->getAliases() as $alias) { $this->commands[$alias] = $command; } return $command; } /** * Configures the console input and output instances for the process. * * @return void * * @since 2.0.0 */ protected function configureIO(): void { if ($this->consoleInput->hasParameterOption(['--ansi'], true)) { $this->consoleOutput->setDecorated(true); } elseif ($this->consoleInput->hasParameterOption(['--no-ansi'], true)) { $this->consoleOutput->setDecorated(false); } if ($this->consoleInput->hasParameterOption(['--no-interaction', '-n'], true)) { $this->consoleInput->setInteractive(false); } if ($this->consoleInput->hasParameterOption(['--quiet', '-q'], true)) { $this->consoleOutput->setVerbosity(OutputInterface::VERBOSITY_QUIET); $this->consoleInput->setInteractive(false); } else { if ($this->consoleInput->hasParameterOption('-vvv', true) || $this->consoleInput->hasParameterOption('--verbose=3', true) || $this->consoleInput->getParameterOption('--verbose', false, true) === 3 ) { $this->consoleOutput->setVerbosity(OutputInterface::VERBOSITY_DEBUG); } elseif ($this->consoleInput->hasParameterOption('-vv', true) || $this->consoleInput->hasParameterOption('--verbose=2', true) || $this->consoleInput->getParameterOption('--verbose', false, true) === 2 ) { $this->consoleOutput->setVerbosity(OutputInterface::VERBOSITY_VERY_VERBOSE); } elseif ($this->consoleInput->hasParameterOption('-v', true) || $this->consoleInput->hasParameterOption('--verbose=1', true) || $this->consoleInput->hasParameterOption('--verbose', true) || $this->consoleInput->getParameterOption('--verbose', false, true) ) { $this->consoleOutput->setVerbosity(OutputInterface::VERBOSITY_VERBOSE); } } } /** * Method to run the application routines. * * @return integer The exit code for the application * * @since 2.0.0 * @throws \Throwable */ protected function doExecute(): int { $input = $this->consoleInput; $output = $this->consoleOutput; // If requesting the version, short circuit the application and send the version data if ($input->hasParameterOption(['--version', '-V'], true)) { $output->writeln($this->getLongVersion()); return 0; } try { // Makes ArgvInput::getFirstArgument() able to distinguish an option from an argument. $input->bind($this->getDefinition()); } catch (ExceptionInterface $e) { // Errors must be ignored, full binding/validation happens later when the command is known. } $name = $this->getCommandName($input); // Redirect to the help command if requested if ($input->hasParameterOption(['--help', '-h'], true)) { // If no command name was given, use the help command with a minimal input; otherwise flag the request for processing later if (!$name) { $name = 'help'; $input = new ArrayInput(['command_name' => $this->defaultCommand]); } else { $this->wantsHelp = true; } } // If we still do not have a command name, then the user has requested the application's default command if (!$name) { $name = $this->defaultCommand; $definition = $this->getDefinition(); // Overwrite the default value of the command argument with the default command name $definition->setArguments( array_merge( $definition->getArguments(), [ 'command' => new InputArgument( 'command', InputArgument::OPTIONAL, $definition->getArgument('command')->getDescription(), $name ), ] ) ); } try { $this->runningCommand = null; $command = $this->getCommand($name); } catch (\Throwable $e) { if ($e instanceof CommandNotFoundException && !($e instanceof NamespaceNotFoundException)) { (new SymfonyStyle($input, $output))->block(sprintf("\nCommand \"%s\" is not defined.\n", $name), null, 'error'); } $event = new CommandErrorEvent($e, $this); $this->dispatchEvent(ConsoleEvents::COMMAND_ERROR, $event); if ($event->getExitCode() === 0) { return 0; } $e = $event->getError(); throw $e; } $this->runningCommand = $command; $exitCode = $this->runCommand($command, $input, $output); $this->runningCommand = null; return $exitCode; } /** * Execute the application. * * @return void * * @since 2.0.0 * @throws \Throwable */ public function execute() { putenv('LINES=' . $this->terminal->getHeight()); putenv('COLUMNS=' . $this->terminal->getWidth()); $this->configureIO(); $renderThrowable = function (\Throwable $e) { $this->renderThrowable($e); }; if ($phpHandler = set_exception_handler($renderThrowable)) { restore_exception_handler(); if (!\is_array($phpHandler) || !$phpHandler[0] instanceof ErrorHandler) { $errorHandler = true; } elseif ($errorHandler = $phpHandler[0]->setExceptionHandler($renderThrowable)) { $phpHandler[0]->setExceptionHandler($errorHandler); } } try { $this->dispatchEvent(ApplicationEvents::BEFORE_EXECUTE); // Perform application routines. $exitCode = $this->doExecute(); $this->dispatchEvent(ApplicationEvents::AFTER_EXECUTE); } catch (\Throwable $throwable) { if (!$this->shouldCatchThrowables()) { throw $throwable; } $renderThrowable($throwable); $event = new ApplicationErrorEvent($throwable, $this, $this->runningCommand); $this->dispatchEvent(ConsoleEvents::APPLICATION_ERROR, $event); $exitCode = $event->getExitCode(); if (is_numeric($exitCode)) { $exitCode = (int) $exitCode; if ($exitCode === 0) { $exitCode = 1; } } else { $exitCode = 1; } } finally { // If the exception handler changed, keep it; otherwise, unregister $renderThrowable if (!$phpHandler) { if (set_exception_handler($renderThrowable) === $renderThrowable) { restore_exception_handler(); } restore_exception_handler(); } elseif (!$errorHandler) { $finalHandler = $phpHandler[0]->setExceptionHandler(null); if ($finalHandler !== $renderThrowable) { $phpHandler[0]->setExceptionHandler($finalHandler); } } if ($this->shouldAutoExit() && isset($exitCode)) { $exitCode = $exitCode > 255 ? 255 : $exitCode; $this->close($exitCode); } } } /** * Finds a registered namespace by a name. * * @param string $namespace A namespace to search for * * @return string * * @since 2.0.0 * @throws NamespaceNotFoundException When namespace is incorrect or ambiguous */ public function findNamespace(string $namespace): string { $allNamespaces = $this->getNamespaces(); $expr = preg_replace_callback( '{([^:]+|)}', function ($matches) { return preg_quote($matches[1]) . '[^:]*'; }, $namespace ); $namespaces = preg_grep('{^' . $expr . '}', $allNamespaces); if (empty($namespaces)) { throw new NamespaceNotFoundException(sprintf('There are no commands defined in the "%s" namespace.', $namespace)); } $exact = \in_array($namespace, $namespaces, true); if (\count($namespaces) > 1 && !$exact) { throw new NamespaceNotFoundException(sprintf('The namespace "%s" is ambiguous.', $namespace)); } return $exact ? $namespace : reset($namespaces); } /** * Gets all commands, including those available through a command loader, optionally filtered on a command namespace. * * @param string $namespace An optional command namespace to filter by. * * @return AbstractCommand[] * * @since 2.0.0 */ public function getAllCommands(string $namespace = ''): array { $this->initCommands(); if ($namespace === '') { $commands = $this->commands; if (!$this->commandLoader) { return $commands; } foreach ($this->commandLoader->getNames() as $name) { if (!isset($commands[$name])) { $commands[$name] = $this->getCommand($name); } } return $commands; } $commands = []; foreach ($this->commands as $name => $command) { if ($namespace === $this->extractNamespace($name, substr_count($namespace, ':') + 1)) { $commands[$name] = $command; } } if ($this->commandLoader) { foreach ($this->commandLoader->getNames() as $name) { if (!isset($commands[$name]) && $namespace === $this->extractNamespace($name, substr_count($namespace, ':') + 1)) { $commands[$name] = $this->getCommand($name); } } } return $commands; } /** * Returns a registered command by name or alias. * * @param string $name The command name or alias * * @return AbstractCommand * * @since 2.0.0 * @throws CommandNotFoundException */ public function getCommand(string $name): AbstractCommand { $this->initCommands(); if (!$this->hasCommand($name)) { throw new CommandNotFoundException(sprintf('The command "%s" does not exist.', $name)); } // If the command isn't registered, pull it from the loader if registered if (!isset($this->commands[$name]) && $this->commandLoader) { $this->addCommand($this->commandLoader->get($name)); } $command = $this->commands[$name]; // If the user requested help, we'll fetch the help command now and inject the user's command into it if ($this->wantsHelp) { $this->wantsHelp = false; /** @var HelpCommand $helpCommand */ $helpCommand = $this->getCommand('help'); $helpCommand->setCommand($command); return $helpCommand; } return $command; } /** * Get the name of the command to run. * * @param InputInterface $input The input to read the argument from * * @return string|null * * @since 2.0.0 */ protected function getCommandName(InputInterface $input): ?string { return $input->getFirstArgument(); } /** * Get the registered commands. * * This method only retrieves commands which have been explicitly registered. To get all commands including those from a * command loader, use the `getAllCommands()` method. * * @return AbstractCommand[] * * @since 2.0.0 */ public function getCommands(): array { return $this->commands; } /** * Get the console input handler. * * @return InputInterface * * @since 2.0.0 */ public function getConsoleInput(): InputInterface { return $this->consoleInput; } /** * Get the console output handler. * * @return OutputInterface * * @since 2.0.0 */ public function getConsoleOutput(): OutputInterface { return $this->consoleOutput; } /** * Get the commands which should be registered by default to the application. * * @return AbstractCommand[] * * @since 2.0.0 */ protected function getDefaultCommands(): array { return [ new Command\ListCommand, new Command\HelpCommand, ]; } /** * Builds the default input definition. * * @return InputDefinition * * @since 2.0.0 */ protected function getDefaultInputDefinition(): InputDefinition { return new InputDefinition( [ new InputArgument('command', InputArgument::REQUIRED, 'The command to execute'), new InputOption('--help', '-h', InputOption::VALUE_NONE, 'Display the help information'), new InputOption('--quiet', '-q', InputOption::VALUE_NONE, 'Flag indicating that all output should be silenced'), new InputOption( '--verbose', '-v|vv|vvv', InputOption::VALUE_NONE, 'Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug' ), new InputOption('--version', '-V', InputOption::VALUE_NONE, 'Displays the application version'), new InputOption('--ansi', '', InputOption::VALUE_NONE, 'Force ANSI output'), new InputOption('--no-ansi', '', InputOption::VALUE_NONE, 'Disable ANSI output'), new InputOption('--no-interaction', '-n', InputOption::VALUE_NONE, 'Flag to disable interacting with the user'), ] ); } /** * Builds the default helper set. * * @return HelperSet * * @since 2.0.0 */ protected function getDefaultHelperSet(): HelperSet { return new HelperSet( [ new FormatterHelper, new DebugFormatterHelper, new ProcessHelper, new QuestionHelper, ] ); } /** * Gets the InputDefinition related to this Application. * * @return InputDefinition * * @since 2.0.0 */ public function getDefinition(): InputDefinition { if (!$this->definition) { $this->definition = $this->getDefaultInputDefinition(); } return $this->definition; } /** * Get the helper set associated with the application. * * @return HelperSet */ public function getHelperSet(): HelperSet { if (!$this->helperSet) { $this->helperSet = $this->getDefaultHelperSet(); } return $this->helperSet; } /** * Get the long version string for the application. * * Typically, this is the application name and version and is used in the application help output. * * @return string * * @since 2.0.0 */ public function getLongVersion(): string { $name = $this->getName(); if ($name === '') { $name = 'Joomla Console Application'; } if ($this->getVersion() !== '') { return sprintf('%s <info>%s</info>', $name, $this->getVersion()); } return $name; } /** * Get the name of the application. * * @return string * * @since 2.0.0 */ public function getName(): string { return $this->name; } /** * Returns an array of all unique namespaces used by currently registered commands. * * Note that this does not include the global namespace which always exists. * * @return string[] * * @since 2.0.0 */ public function getNamespaces(): array { $namespaces = []; foreach ($this->getAllCommands() as $command) { $namespaces = array_merge($namespaces, $this->extractAllNamespaces($command->getName())); foreach ($command->getAliases() as $alias) { $namespaces = array_merge($namespaces, $this->extractAllNamespaces($alias)); } } return array_values(array_unique(array_filter($namespaces))); } /** * Get the version of the application. * * @return string * * @since 2.0.0 */ public function getVersion(): string { return $this->version; } /** * Check if the application has a command with the given name. * * @param string $name The name of the command to check for existence. * * @return boolean * * @since 2.0.0 */ public function hasCommand(string $name): bool { $this->initCommands(); // If command is already registered, we're good if (isset($this->commands[$name])) { return true; } // If there is no loader, we can't look for a command there if (!$this->commandLoader) { return false; } return $this->commandLoader->has($name); } /** * Custom initialisation method. * * @return void * * @since 2.0.0 */ protected function initialise(): void { // Set the current directory. $this->set('cwd', getcwd()); } /** * Renders an error message for a Throwable object * * @param \Throwable $throwable The Throwable object to render the message for. * * @return void * * @since 2.0.0 */ public function renderThrowable(\Throwable $throwable): void { $output = $this->consoleOutput instanceof ConsoleOutputInterface ? $this->consoleOutput->getErrorOutput() : $this->consoleOutput; $output->writeln('', OutputInterface::VERBOSITY_QUIET); $this->doRenderThrowable($throwable, $output); if (null !== $this->runningCommand) { $output->writeln( sprintf( '<info>%s</info>', sprintf($this->runningCommand->getSynopsis(), $this->getName()) ), OutputInterface::VERBOSITY_QUIET ); $output->writeln('', OutputInterface::VERBOSITY_QUIET); } } /** * Handles recursively rendering error messages for a Throwable and all previous Throwables contained within. * * @param \Throwable $throwable The Throwable object to render the message for. * @param OutputInterface $output The output object to send the message to. * * @return void * * @since 2.0.0 */ protected function doRenderThrowable(\Throwable $throwable, OutputInterface $output): void { do { $message = trim($throwable->getMessage()); if ($message === '' || OutputInterface::VERBOSITY_VERBOSE <= $output->getVerbosity()) { $class = \get_class($throwable); if ($class[0] === 'c' && strpos($class, "class@anonymous\0") === 0) { $class = get_parent_class($class) ?: key(class_implements($class)); } $title = sprintf(' [%s%s] ', $class, ($code = $throwable->getCode()) !== 0 ? ' (' . $code . ')' : ''); $len = StringHelper::strlen($title); } else { $len = 0; } if (strpos($message, "class@anonymous\0") !== false) { $message = preg_replace_callback( '/class@anonymous\x00.*?\.php(?:0x?|:[0-9]++\$)[0-9a-fA-F]++/', function ($m) { return class_exists($m[0], false) ? (get_parent_class($m[0]) ?: key(class_implements($m[0]))) . '@anonymous' : $m[0]; }, $message ); } $width = $this->terminal->getWidth() ? $this->terminal->getWidth() - 1 : PHP_INT_MAX; $lines = []; foreach ($message !== '' ? preg_split('/\r?\n/', $message) : [] as $line) { foreach ($this->splitStringByWidth($line, $width - 4) as $line) { // Pre-format lines to get the right string length $lineLength = StringHelper::strlen($line) + 4; $lines[] = [$line, $lineLength]; $len = max($lineLength, $len); } } $messages = []; if (!$throwable instanceof ExceptionInterface || OutputInterface::VERBOSITY_VERBOSE <= $output->getVerbosity()) { $messages[] = sprintf( '<comment>%s</comment>', OutputFormatter::escape( sprintf( 'In %s line %s:', basename($throwable->getFile()) ?: 'n/a', $throwable->getLine() ?: 'n/a' ) ) ); } $messages[] = $emptyLine = sprintf('<error>%s</error>', str_repeat(' ', $len)); if ($message === '' || OutputInterface::VERBOSITY_VERBOSE <= $output->getVerbosity()) { $messages[] = sprintf('<error>%s%s</error>', $title, str_repeat(' ', max(0, $len - StringHelper::strlen($title)))); } foreach ($lines as $line) { $messages[] = sprintf('<error> %s %s</error>', OutputFormatter::escape($line[0]), str_repeat(' ', $len - $line[1])); } $messages[] = $emptyLine; $messages[] = ''; $output->writeln($messages, OutputInterface::VERBOSITY_QUIET); if (OutputInterface::VERBOSITY_VERBOSE <= $output->getVerbosity()) { $output->writeln('<comment>Exception trace:</comment>', OutputInterface::VERBOSITY_QUIET); // Exception related properties $trace = $throwable->getTrace(); array_unshift( $trace, [ 'function' => '', 'file' => $throwable->getFile() ?: 'n/a', 'line' => $throwable->getLine() ?: 'n/a', 'args' => [], ] ); for ($i = 0, $count = \count($trace); $i < $count; ++$i) { $class = $trace[$i]['class'] ?? ''; $type = $trace[$i]['type'] ?? ''; $function = $trace[$i]['function'] ?? ''; $file = $trace[$i]['file'] ?? 'n/a'; $line = $trace[$i]['line'] ?? 'n/a'; $output->writeln( sprintf( ' %s%s at <info>%s:%s</info>', $class, $function ? $type . $function . '()' : '', $file, $line ), OutputInterface::VERBOSITY_QUIET ); } $output->writeln('', OutputInterface::VERBOSITY_QUIET); } } while ($throwable = $throwable->getPrevious()); } /** * Splits a string for a specified width for use in an output. * * @param string $string The string to split. * @param integer $width The maximum width of the output. * * @return string[] * * @since 2.0.0 */ private function splitStringByWidth(string $string, int $width): array { /* * The str_split function is not suitable for multi-byte characters, we should use preg_split to get char array properly. * Additionally, array_slice() is not enough as some character has doubled width. * We need a function to split string not by character count but by string width */ if (false === $encoding = mb_detect_encoding($string, null, true)) { return str_split($string, $width); } $utf8String = mb_convert_encoding($string, 'utf8', $encoding); $lines = []; $line = ''; $offset = 0; while (preg_match('/.{1,10000}/u', $utf8String, $m, 0, $offset)) { $offset += \strlen($m[0]); foreach (preg_split('//u', $m[0]) as $char) { // Test if $char could be appended to current line if (mb_strwidth($line . $char, 'utf8') <= $width) { $line .= $char; continue; } // If not, push current line to array and make a new line $lines[] = str_pad($line, $width); $line = $char; } } $lines[] = \count($lines) ? str_pad($line, $width) : $line; mb_convert_variables($encoding, 'utf8', $lines); return $lines; } /** * Run the given command. * * @param AbstractCommand $command The command to run. * @param InputInterface $input The input to inject into the command. * @param OutputInterface $output The output to inject into the command. * * @return integer * * @since 2.0.0 * @throws \Throwable */ protected function runCommand(AbstractCommand $command, InputInterface $input, OutputInterface $output): int { if ($command->getHelperSet() !== null) { foreach ($command->getHelperSet() as $helper) { if ($helper instanceof InputAwareInterface) { $helper->setInput($input); } } } // If the application doesn't have an event dispatcher, we can short circuit and just execute the command try { $this->getDispatcher(); } catch (\UnexpectedValueException $exception) { return $command->execute($input, $output); } // Bind before dispatching the event so the listeners have access to input options/arguments try { $command->mergeApplicationDefinition(); $input->bind($command->getDefinition()); } catch (ExceptionInterface $e) { // Ignore invalid options/arguments for now } $event = new BeforeCommandExecuteEvent($this, $command); $exception = null; try { $this->dispatchEvent(ConsoleEvents::BEFORE_COMMAND_EXECUTE, $event); if ($event->isCommandEnabled()) { $exitCode = $command->execute($input, $output); } else { $exitCode = BeforeCommandExecuteEvent::RETURN_CODE_DISABLED; } } catch (\Throwable $exception) { $event = new CommandErrorEvent($exception, $this, $command); $this->dispatchEvent(ConsoleEvents::COMMAND_ERROR, $event); $exception = $event->getError(); $exitCode = $event->getExitCode(); if ($exitCode === 0) { $exception = null; } } $event = new TerminateEvent($exitCode, $this, $command); $this->dispatchEvent(ConsoleEvents::TERMINATE, $event); if ($exception !== null) { throw $exception; } return $event->getExitCode(); } /** * Set whether the application should auto exit. * * @param boolean $autoExit The auto exit state. * * @return void * * @since 2.0.0 */ public function setAutoExit(bool $autoExit): void { $this->autoExit = $autoExit; } /** * Set whether the application should catch Throwables. * * @param boolean $catchThrowables The catch Throwables state. * * @return void * * @since 2.0.0 */ public function setCatchThrowables(bool $catchThrowables): void { $this->catchThrowables = $catchThrowables; } /** * Set the command loader. * * @param Loader\LoaderInterface $loader The new command loader. * * @return void * * @since 2.0.0 */ public function setCommandLoader(Loader\LoaderInterface $loader): void { $this->commandLoader = $loader; } /** * Set the application's helper set. * * @param HelperSet $helperSet The new HelperSet. * * @return void * * @since 2.0.0 */ public function setHelperSet(HelperSet $helperSet): void { $this->helperSet = $helperSet; } /** * Set the name of the application. * * @param string $name The new application name. * * @return void * * @since 2.0.0 */ public function setName(string $name): void { $this->name = $name; } /** * Set the version of the application. * * @param string $version The new application version. * * @return void * * @since 2.0.0 */ public function setVersion(string $version): void { $this->version = $version; } /** * Get the application's auto exit state. * * @return boolean * * @since 2.0.0 */ public function shouldAutoExit(): bool { return $this->autoExit; } /** * Get the application's catch Throwables state. * * @return boolean * * @since 2.0.0 */ public function shouldCatchThrowables(): bool { return $this->catchThrowables; } /** * Returns all namespaces of the command name. * * @param string $name The full name of the command * * @return string[] * * @since 2.0.0 */ private function extractAllNamespaces(string $name): array { // -1 as third argument is needed to skip the command short name when exploding $parts = explode(':', $name, -1); $namespaces = []; foreach ($parts as $part) { if (\count($namespaces)) { $namespaces[] = end($namespaces) . ':' . $part; } else { $namespaces[] = $part; } } return $namespaces; } /** * Returns the namespace part of the command name. * * @param string $name The command name to process * @param integer $limit The maximum number of parts of the namespace * * @return string * * @since 2.0.0 */ private function extractNamespace(string $name, ?int $limit = null): string { $parts = explode(':', $name); array_pop($parts); return implode(':', $limit === null ? $parts : \array_slice($parts, 0, $limit)); } /** * Internal function to initialise the command store, this allows the store to be lazy loaded only when needed. * * @return void * * @since 2.0.0 */ private function initCommands(): void { if ($this->initialised) { return; } $this->initialised = true; foreach ($this->getDefaultCommands() as $command) { $this->addCommand($command); } } } src/Loader/LoaderInterface.php 0000644 00000002000 15173302121 0012264 0 ustar 00 <?php /** * Part of the Joomla Framework Console Package * * @copyright Copyright (C) 2005 - 2021 Open Source Matters, Inc. All rights reserved. * @license GNU General Public License version 2 or later; see LICENSE */ namespace Joomla\Console\Loader; use Joomla\Console\Command\AbstractCommand; use Symfony\Component\Console\Exception\CommandNotFoundException; /** * Interface defining a command loader. * * @since 2.0.0 */ interface LoaderInterface { /** * Loads a command. * * @param string $name The command to load. * * @return AbstractCommand * * @since 2.0.0 * @throws CommandNotFoundException */ public function get(string $name): AbstractCommand; /** * Get the names of the registered commands. * * @return string[] * * @since 2.0.0 */ public function getNames(): array; /** * Checks if a command exists. * * @param string $name The command to check. * * @return boolean * * @since 2.0.0 */ public function has($name): bool; } src/Loader/ContainerLoader.php 0000644 00000004011 15173302121 0012312 0 ustar 00 <?php /** * Part of the Joomla Framework Console Package * * @copyright Copyright (C) 2005 - 2021 Open Source Matters, Inc. All rights reserved. * @license GNU General Public License version 2 or later; see LICENSE */ namespace Joomla\Console\Loader; use Joomla\Console\Command\AbstractCommand; use Psr\Container\ContainerInterface; use Symfony\Component\Console\Exception\CommandNotFoundException; /** * PSR-11 compatible command loader. * * @since 2.0.0 */ final class ContainerLoader implements LoaderInterface { /** * The service container. * * @var ContainerInterface * @since 2.0.0 */ private $container; /** * The command name to service ID map. * * @var string[] * @since 2.0.0 */ private $commandMap; /** * Constructor. * * @param ContainerInterface $container A container from which to load command services. * @param array $commandMap An array with command names as keys and service IDs as values. * * @since 2.0.0 */ public function __construct(ContainerInterface $container, array $commandMap) { $this->container = $container; $this->commandMap = $commandMap; } /** * Loads a command. * * @param string $name The command to load. * * @return AbstractCommand * * @since 2.0.0 * @throws CommandNotFoundException */ public function get(string $name): AbstractCommand { if (!$this->has($name)) { throw new CommandNotFoundException(sprintf('Command "%s" does not exist.', $name)); } return $this->container->get($this->commandMap[$name]); } /** * Get the names of the registered commands. * * @return string[] * * @since 2.0.0 */ public function getNames(): array { return array_keys($this->commandMap); } /** * Checks if a command exists. * * @param string $name The command to check. * * @return boolean * * @since 2.0.0 */ public function has($name): bool { return isset($this->commandMap[$name]) && $this->container->has($this->commandMap[$name]); } } .drone.yml 0000644 00000016557 15173302121 0006465 0 ustar 00 --- { "kind": "pipeline", "name": "Codequality", "steps": [ { "commands": [ "php -v", "composer update", "composer require phpmd/phpmd phpstan/phpstan" ], "image": "joomlaprojects/docker-images:php7.4", "name": "composer", "volumes": [ { "name": "composer-cache", "path": "/tmp/composer-cache" } ] }, { "commands": [ "vendor/bin/phpcs --config-set installed_paths vendor/joomla/coding-standards", "vendor/bin/phpcs --standard=ruleset.xml src/" ], "depends": [ "composer" ], "image": "joomlaprojects/docker-images:php7.4", "name": "phpcs" }, { "commands": [ "vendor/bin/phpmd src text cleancode", "vendor/bin/phpmd src text codesize", "vendor/bin/phpmd src text controversial", "vendor/bin/phpmd src text design", "vendor/bin/phpmd src text unusedcode" ], "depends": [ "composer" ], "failure": "ignore", "image": "joomlaprojects/docker-images:php7.4", "name": "phpmd" }, { "commands": [ "vendor/bin/phpstan analyse src" ], "depends": [ "composer" ], "failure": "ignore", "image": "joomlaprojects/docker-images:php7.4", "name": "phpstan" }, { "commands": [ "phploc src" ], "depends": [ "composer" ], "failure": "ignore", "image": "joomlaprojects/docker-images:php7.4", "name": "phploc" }, { "commands": [ "phpcpd src" ], "depends": [ "composer" ], "failure": "ignore", "image": "joomlaprojects/docker-images:php7.4", "name": "phpcpd" } ], "volumes": [ { "host": { "path": "/tmp/composer-cache" }, "name": "composer-cache" } ] } --- { "kind": "pipeline", "name": "PHP 7.2 lowest", "steps": [ { "commands": [ "php -v", "composer update --prefer-stable --prefer-lowest" ], "image": "joomlaprojects/docker-images:php7.2", "name": "composer", "volumes": [ { "name": "composer-cache", "path": "/tmp/composer-cache" } ] }, { "commands": [ "vendor/bin/phpunit" ], "image": "joomlaprojects/docker-images:php7.2", "name": "PHPUnit" } ], "volumes": [ { "host": { "path": "/tmp/composer-cache" }, "name": "composer-cache" } ] } --- { "kind": "pipeline", "name": "PHP 7.2", "steps": [ { "commands": [ "php -v", "composer update --prefer-stable" ], "image": "joomlaprojects/docker-images:php7.2", "name": "composer", "volumes": [ { "name": "composer-cache", "path": "/tmp/composer-cache" } ] }, { "commands": [ "vendor/bin/phpunit" ], "image": "joomlaprojects/docker-images:php7.2", "name": "PHPUnit" } ], "volumes": [ { "host": { "path": "/tmp/composer-cache" }, "name": "composer-cache" } ] } --- { "kind": "pipeline", "name": "PHP 7.3", "steps": [ { "commands": [ "php -v", "composer update --prefer-stable" ], "image": "joomlaprojects/docker-images:php7.3", "name": "composer", "volumes": [ { "name": "composer-cache", "path": "/tmp/composer-cache" } ] }, { "commands": [ "vendor/bin/phpunit" ], "image": "joomlaprojects/docker-images:php7.3", "name": "PHPUnit" } ], "volumes": [ { "host": { "path": "/tmp/composer-cache" }, "name": "composer-cache" } ] } --- { "kind": "pipeline", "name": "PHP 7.4", "steps": [ { "commands": [ "php -v", "composer update --prefer-stable" ], "image": "joomlaprojects/docker-images:php7.4", "name": "composer", "volumes": [ { "name": "composer-cache", "path": "/tmp/composer-cache" } ] }, { "commands": [ "vendor/bin/phpunit" ], "image": "joomlaprojects/docker-images:php7.4", "name": "PHPUnit" } ], "volumes": [ { "host": { "path": "/tmp/composer-cache" }, "name": "composer-cache" } ] } --- { "kind": "pipeline", "name": "PHP 8.0", "steps": [ { "commands": [ "php -v", "composer update --prefer-stable" ], "image": "joomlaprojects/docker-images:php8.0", "name": "composer", "volumes": [ { "name": "composer-cache", "path": "/tmp/composer-cache" } ] }, { "commands": [ "vendor/bin/phpunit" ], "image": "joomlaprojects/docker-images:php8.0", "name": "PHPUnit" } ], "volumes": [ { "host": { "path": "/tmp/composer-cache" }, "name": "composer-cache" } ] } --- { "kind": "pipeline", "name": "PHP 8.1", "steps": [ { "commands": [ "php -v", "composer update --prefer-stable" ], "image": "joomlaprojects/docker-images:php8.1", "name": "composer", "volumes": [ { "name": "composer-cache", "path": "/tmp/composer-cache" } ] }, { "commands": [ "vendor/bin/phpunit" ], "image": "joomlaprojects/docker-images:php8.1", "name": "PHPUnit" } ], "volumes": [ { "host": { "path": "/tmp/composer-cache" }, "name": "composer-cache" } ] } --- { "kind": "pipeline", "name": "PHP 8.2", "steps": [ { "commands": [ "php -v", "composer update --prefer-stable --ignore-platform-reqs" ], "image": "joomlaprojects/docker-images:php8.2", "name": "composer", "volumes": [ { "name": "composer-cache", "path": "/tmp/composer-cache" } ] }, { "commands": [ "vendor/bin/phpunit" ], "failure": "ignore", "image": "joomlaprojects/docker-images:php8.2", "name": "PHPUnit" } ], "volumes": [ { "host": { "path": "/tmp/composer-cache" }, "name": "composer-cache" } ] } --- kind: signature hmac: d08e6f776c4c8e1ced520d903f1d524f96319eafcc8da82d2936b4473df36a3f ... .drone.jsonnet 0000644 00000006624 15173302121 0007336 0 ustar 00 local volumes = [ { name: "composer-cache", path: "/tmp/composer-cache", }, ]; local hostvolumes = [ { name: "composer-cache", host: {path: "/tmp/composer-cache"} }, ]; local composer(phpversion, params) = { name: "composer", image: "joomlaprojects/docker-images:php" + phpversion, volumes: volumes, commands: [ "php -v", "composer update " + params, ] }; local phpunit(phpversion) = { name: "PHPUnit", image: "joomlaprojects/docker-images:php" + phpversion, [if phpversion == "8.2" then "failure"]: "ignore", commands: ["vendor/bin/phpunit"] }; local pipeline(name, phpversion, params) = { kind: "pipeline", name: "PHP " + name, volumes: hostvolumes, steps: [ composer(phpversion, params), phpunit(phpversion) ], }; [ { kind: "pipeline", name: "Codequality", volumes: hostvolumes, steps: [ { name: "composer", image: "joomlaprojects/docker-images:php7.4", volumes: volumes, commands: [ "php -v", "composer update", "composer require phpmd/phpmd phpstan/phpstan" ] }, { name: "phpcs", image: "joomlaprojects/docker-images:php7.4", depends: [ "composer" ], commands: [ "vendor/bin/phpcs --config-set installed_paths vendor/joomla/coding-standards", "vendor/bin/phpcs --standard=ruleset.xml src/" ] }, { name: "phpmd", image: "joomlaprojects/docker-images:php7.4", depends: [ "composer" ], failure: "ignore", commands: [ "vendor/bin/phpmd src text cleancode", "vendor/bin/phpmd src text codesize", "vendor/bin/phpmd src text controversial", "vendor/bin/phpmd src text design", "vendor/bin/phpmd src text unusedcode", ] }, { name: "phpstan", image: "joomlaprojects/docker-images:php7.4", depends: [ "composer" ], failure: "ignore", commands: [ "vendor/bin/phpstan analyse src", ] }, { name: "phploc", image: "joomlaprojects/docker-images:php7.4", depends: [ "composer" ], failure: "ignore", commands: [ "phploc src", ] }, { name: "phpcpd", image: "joomlaprojects/docker-images:php7.4", depends: [ "composer" ], failure: "ignore", commands: [ "phpcpd src", ] } ] }, pipeline("7.2 lowest", "7.2", "--prefer-stable --prefer-lowest"), pipeline("7.2", "7.2", "--prefer-stable"), pipeline("7.3", "7.3", "--prefer-stable"), pipeline("7.4", "7.4", "--prefer-stable"), pipeline("8.0", "8.0", "--prefer-stable"), pipeline("8.1", "8.1", "--prefer-stable"), pipeline("8.2", "8.2", "--prefer-stable --ignore-platform-reqs"), ]
| ver. 1.4 |
Github
|
.
| PHP 8.3.23 | Generation time: 0 |
proxy
|
phpinfo
|
Settings