prof: add some helper methods from cli-utils

Author: inhere

src/CliApp.php

@@ -16,6 +16,7 @@
 use Toolkit\PFlag\Exception\FlagException;
 use Toolkit\PFlag\FlagsParser;
 use Toolkit\PFlag\FlagType;
+use Toolkit\PFlag\FlagUtil;
 use Toolkit\Stdlib\Obj;
 use Toolkit\Stdlib\OS;
 use function is_array;
@@ -303,7 +304,7 @@ public function getName(): string
      */
     public function setName(string $name): void
     {
-        if (!FlagHelper::isValidName($name)) {
+        if (!FlagUtil::isValidName($name)) {
             throw new FlagException("invalid flag option name: $name");
         }
 

src/Flag/AbstractFlag.php

@@ -9,9 +9,9 @@
 
 namespace Toolkit\PFlag\Flag;
 
-use Toolkit\Cli\Helper\FlagHelper;
 use Toolkit\PFlag\Exception\FlagException;
 use Toolkit\PFlag\FlagsParser;
+use Toolkit\PFlag\FlagUtil;
 use Toolkit\Stdlib\Str;
 use function sprintf;
 
@@ -36,7 +36,7 @@ class Argument extends AbstractFlag
     public function setName(string $name): void
     {
         if ($name) {
-            if (!FlagHelper::isValidName($name)) {
+            if (!FlagUtil::isValidName($name)) {
                 $mark = sprintf('#%d(%s)', $this->index, $name);
                 throw new FlagException("invalid flag argument name: $mark");
             }

src/Flag/Argument.php

@@ -12,6 +12,7 @@
 use Toolkit\Cli\Helper\FlagHelper;
 use Toolkit\PFlag\Exception\FlagException;
 use Toolkit\PFlag\FlagType;
+use Toolkit\PFlag\FlagUtil;
 use Toolkit\Stdlib\Str;
 use function array_filter;
 use function array_map;
@@ -88,7 +89,7 @@ public function setAlias(string $alias): void
             return;
         }
 
-        if (!FlagHelper::isValidName($alias)) {
+        if (!FlagUtil::isValidName($alias)) {
             throw new FlagException('invalid option alias: ' . $alias);
         }
 

src/Flag/Option.php

@@ -172,7 +172,8 @@ public static function fmtBasicTypeValue(string $type, $value)
                 break;
             case self::BOOL:
                 if (is_string($value)) {
-                    $value = FlagHelper::str2bool($value);
+                    // $value = FlagHelper::str2bool($value);
+                    $value = Str::toBool2($value);
                 } else {
                     $value = (bool)$value;
                 }

src/FlagType.php

@@ -5,16 +5,21 @@
 use function array_map;
 use function array_shift;
 use function basename;
+use function escapeshellarg;
+use function explode;
 use function implode;
 use function is_numeric;
 use function ltrim;
+use function preg_match;
 use function strlen;
 
 /**
  * class FlagUtil
  */
 class FlagUtil
 {
+    private static ?string $scriptName = null;
+
     /**
      * @param array $names
      *
@@ -74,15 +79,81 @@ public static function getMaxInt(int $val1, int $val2): int
     }
 
     /**
+     * @param bool $refresh
+     *
      * @return string
      */
-    public static function getBinName(): string
+    public static function getBinName(bool $refresh = false): string
     {
-        $script = '';
+        if (!$refresh && self::$scriptName !== null) {
+            return self::$scriptName;
+        }
+
+        $scriptName = '';
         if (isset($_SERVER['argv']) && ($argv = $_SERVER['argv'])) {
-            $script = array_shift($argv);
+            $scriptFile = array_shift($argv);
+            $scriptName = basename($scriptFile);
         }
 
-        return basename($script);
+        self::$scriptName = $scriptName;
+        return self::$scriptName;
+    }
+
+    /**
+     * check input is valid option value
+     *
+     * @param mixed $val
+     *
+     * @return bool
+     */
+    public static function isOptionValue(mixed $val): bool
+    {
+        if ($val === false) {
+            return false;
+        }
+
+        // if is: '', 0
+        if (!$val) {
+            return true;
+        }
+
+        // is not option name.
+        if ($val[0] !== '-') {
+            // ensure is option value.
+            if (!str_contains($val, '=')) {
+                return true;
+            }
+
+            // is string value, but contains '='
+            [$name,] = explode('=', $val, 2);
+
+            // named argument OR invalid: 'some = string'
+            return false === self::isValidName($name);
+        }
+
+        // is option name.
+        return false;
+    }
+
+    /**
+     * @param string $name
+     *
+     * @return bool
+     */
+    public static function isValidName(string $name): bool
+    {
+        return preg_match('#^[a-zA-Z_][\w-]{0,36}$#', $name) === 1;
+    }
+
+    /**
+     * Escapes a token through escape shell arg if it contains unsafe chars.
+     *
+     * @param string $token
+     *
+     * @return string
+     */
+    public static function escapeToken(string $token): string
+    {
+        return preg_match('{^[\w-]+$}', $token) ? $token : escapeshellarg($token);
     }
 }

src/FlagUtil.php

@@ -299,7 +299,7 @@ protected function parseRawArgs(array $rawArgs): array
                 [$name, $value] = explode('=', $arg, 2);
 
                 // ensure is valid name.
-                if (FlagHelper::isValidName($name)) {
+                if (FlagUtil::isValidName($name)) {
                     $args[$name] = $value;
                 } else {
                     $args[] = $arg;

src/FlagsParser.php

@@ -420,7 +420,7 @@ public function doParse(array $flags): bool
                 // check if next element is a descriptor or a value
                 $next = current($flags);
                 if ($hasVal === false && $isBool === false) {
-                    if (false === FlagHelper::isOptionValue($next)) {
+                    if (false === FlagUtil::isOptionValue($next)) {
                         throw new FlagParseException("must provide value for the option: $p", 404);
                     }
 
@@ -655,7 +655,7 @@ protected function checkDefine(array $define, string $mark, string $kind = self:
         }
 
         // check name.
-        if ((self::KIND_OPT === $kind || $name) && !FlagHelper::isValidName($name)) {
+        if ((self::KIND_OPT === $kind || $name) && !FlagUtil::isValidName($name)) {
             throw new FlagException("invalid flag $kind name: $mark");
         }