lainwir3d/dolibarr
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #24626 from alexandre-janniaux/install-inc-getopt-fix/1

Browse Source 
Fix: install/inc: fix some issues on option parsing and add documentation
This commit is contained in:
Laurent Destailleur 2023-04-28 20:41:17 +02:00 committed by GitHub
commit 4658d9676d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 33 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
htdocs/install/inc.php
View File

@ -93,9 +93,20 @@ $long_options = array(
function usage($program, $header)
{
echo $header."\n";
echo " php ".$program." [options] previous_version new_version [script options]\n";
echo " php ".$program." [options] [script options]\n";
echo "\n";
echo "Script options when using upgrade.php:\n";
echo "Script syntax when using step2.php:\n";
echo " php ".$program." [options] [action] [selectlang]\n";
echo "\n";
echo " action:\n";
echo " Specify the action to execute for the file among the following ones.\n";
echo " - set: Create tables, keys, functions and data for the instance.\n";
echo "\n";
echo " selectlang:\n";
echo " Setup the default lang to use, default to 'auto'.\n";
echo "\n";
echo "Script syntax when using upgrade.php:\n";
echo " php ".$program." [options] previous_version new_version [script options]\n";
echo "\n";
echo " dirmodule:\n";
echo " Specify dirmodule to provide a path for an external module\n";
@ -105,10 +116,11 @@ function usage($program, $header)
echo " Allow to run migration even if database version does\n";
echo " not match start version of migration.\n";
echo "\n";
echo "Script options when using upgrade2.php:\n";
echo "Script syntax when using upgrade2.php:\n";
echo " php ".$program." [options] previous_version new_version [module list]\n";
echo "\n";
echo " MODULE_NAME1_TO_ENABLE,MODULE_NAME2_TO_ENABLE:\n";
echo " Specify a list of module-name to enable, joined by comma.\n";
echo " MAIN_MODULE_NAME1,MAIN_MODULE_NAME2:\n";
echo " Specify a list of module-name to enable, in upper case, with MAIN_MODULE_ prefix, joined by comma.\n";
echo "\n";
echo "Options:\n";
echo " -c, --config <filename>:\n";
@ -134,19 +146,26 @@ if (php_sapi_name() === "cli") {
exit(0);
}
// Parse the arguments to find the options.
$args_options = array_filter(array_slice($argv, 0, $rest_index), function ($arg) {
return strlen($arg) >= 2 && $arg[0] == '-';
});
$parsed_options = array_map(function ($arg) {
if (strlen($arg) > 1)
return "--" . $arg;
return "-" . $arg;
}, array_keys($opts));
// Find options (dash-prefixed) that were not parsed.
$unknown_options = array_diff($args_options, $parsed_options);
// In the following test, only dash-prefixed arguments will trigger an
// error, given that scripts options can allow a variable number of
// additional non-prefixed argument and we mostly want to check for
// typo right now.
if ($rest_index < $argc && $argv[$rest_index][0] == "-") {
usage($argv[0], "Unknown option ".$argv[$rest_index]. ", usage:");
exit(1);
}
// Currently, scripts using inc.php will require addtional arguments,
// see help above for more details.
if ($rest_index > $argc - 2) {
usage($argv[0], "Missing mandatory arguments, usage:");
if (count($unknown_options) > 0) {
echo "Unknown option: ".array_values($unknown_options)[0]."\n";
usage($argv[0], "Usage:");
exit(1);
}