X-Git-Url: https://git.rapsys.eu/packbundle/blobdiff_plain/57148c75381fac1f83a4afe886471c6aaa1cc2ea..09e631c7cacd12e04b1bde6b991dedadfff4d747:/Util/SluggerUtil.php?ds=sidebyside diff --git a/Util/SluggerUtil.php b/Util/SluggerUtil.php index 14a128d..3b1e6b5 100644 --- a/Util/SluggerUtil.php +++ b/Util/SluggerUtil.php @@ -12,64 +12,46 @@ namespace Rapsys\PackBundle\Util; /** - * Helps manage string conversions + * Manages string conversions */ class SluggerUtil { - //The secret parameter - private $secret; - - //The alpha array - private $alpha; + /** + * The alpha array + */ + protected array $alpha; - //The rev array - private $rev; + /** + * The rev array + */ + protected array $rev; - //The alpha array key number - private $count; + /** + * The alpha array key number + */ + protected int $count; - //The offset reduced from secret - private $offset; + /** + * The offset reduced from secret + */ + protected int $offset; /** - * Creates a new slugger util + * Construct slugger util + * + * @description Run "php bin/console rapsyspack:range" to generate RAPSYSPACK_RANGE="ayl[...]z9w" range in .env.local * - * @todo Add a command to generate alpha array or generate it on first run with cache storage ? - * @todo Use Cache like in calendar controller through FilesystemAdapter + * @todo Use Cache like in calendar controller through FilesystemAdapter ? * + * @param string $range The shuffled range string * @param string $secret The secret string */ - public function __construct(string $secret) { - //Set secret - $this->secret = $secret; - - //Pseudo-random alphabet - //XXX: use array flip and keys to workaround php "smart" that cast range('0', '9') as int instead of string - //XXX: The key count mismatch, count(alpha)>count(rev), resulted in a data corruption due to duplicate numeric values - $this->alpha = array_keys(array_flip(array_merge( - range('^', '[', -1), - range('V', 'Z'), - range('9', '7', -1), - range('L', 'O'), - range('f', 'a', -1), - range('_', '`'), - range('3', '0', -1), - range('E', 'H'), - range('v', 'r', -1), - range('+', '/'), - range('K', 'I', -1), - range('g', 'j'), - range('=', ':', -1), - range('>', '@'), - range('m', 'k', -1), - range('4', '6'), - range('*', '%', -1), - range('n', 'q'), - range('U', 'P', -1), - range(' ', '$'), - range('D', 'A', -1), - range('w', 'z'), - range('~', '!', -1) - ))); + public function __construct(protected string $range, protected string $secret) { + /** + * Get pseuto-random alphabet by splitting range string + * TODO: see required range by json_encode result and short input (0->255 ???) + * XXX: The key count mismatch, count(alpha)>count(rev), resulted in a data corruption due to duplicate numeric values + */ + $this->alpha = str_split($this->range); //Init rev array $this->count = count($rev = $this->rev = array_flip($this->alpha)); @@ -84,14 +66,14 @@ class SluggerUtil { /** * Flatten recursively an array * - * @param array $data The data tree + * @param array|string $data The data tree * @param string|null $current The current prefix * @param string $sep The key separator * @param string $prefix The key prefix * @param string $suffix The key suffix * @return array The flattened data */ - public function flatten(array $data, mixed $current = null, string $sep = '.', string $prefix = '', string $suffix = ''): array { + public function flatten($data, ?string $current = null, string $sep = '.', string $prefix = '', string $suffix = ''): array { //Init result $ret = []; @@ -115,10 +97,16 @@ class SluggerUtil { /** * Crypt and base64uri encode string * - * @param string $data The data string + * @param array|string $data The data string * @return string The hashed data */ - public function hash(string $data): string { + public function hash(array|string $data): string { + //With array + if (is_array($data)) { + //Json encode array + $data = json_encode($data); + } + //Return hashed data //XXX: we use hash_hmac with md5 hash //XXX: crypt was dropped because it provided identical signature for string starting with same pattern @@ -133,7 +121,8 @@ class SluggerUtil { */ public function serialize(array $data): string { //Return shorted serialized data - return $this->short(serialize($data)); + //XXX: dropped serialize use to prevent short function from dropping utf-8 characters + return $this->short(json_encode($data)); } /** @@ -146,25 +135,36 @@ class SluggerUtil { //Return string $ret = ''; - //Iterate on each character - foreach(str_split($data) as $k => $c) { - if (isset($this->rev[$c]) && isset($this->alpha[($this->rev[$c]+$this->offset)%$this->count])) { - //XXX: Remap char to an other one - $ret .= chr(($this->rev[$c] - $this->offset + $this->count) % $this->count); + //With data + if (!empty($data)) { + //Iterate on each character + foreach(str_split($data) as $k => $c) { + if (isset($this->rev[$c]) && isset($this->alpha[($this->rev[$c]+$this->offset)%$this->count])) { + //XXX: Remap char to an other one + $ret .= chr(($this->rev[$c] - $this->offset + $this->count) % $this->count); + } else { + throw new \RuntimeException(sprintf('Unable to retrieve character: %c', $c)); + } } } //Send result - return str_replace(['+','/'], ['-','_'], base64_encode($ret)); + return str_replace(['+','/','='], ['-','_',''], base64_encode($ret)); } /** * Convert string to safe slug * * @param string $data The data string - * @return string The slugged data + * @return ?string The slugged data */ - function slug(string $data): string { + function slug(?string $data): ?string { + //With null + if ($data === null) { + //Return null + return $data; + } + //Use Transliterator if available if (class_exists('Transliterator')) { //Convert from any to latin, then to ascii and lowercase @@ -172,10 +172,36 @@ class SluggerUtil { //Replace every non alphanumeric character by dash then trim dash return trim(preg_replace('/[^a-zA-Z0-9]+/', '-', $trans->transliterate($data)), '-'); } + //Convert from utf-8 to ascii, replace quotes with space, remove non alphanumericseparator, replace separator with dash and trim dash return trim(preg_replace('/[\/_|+ -]+/', '-', strtolower(preg_replace('/[^a-zA-Z0-9\/_|+ -]/', '', str_replace(['\'', '"'], ' ', iconv('UTF-8', 'ASCII//TRANSLIT', $data))))), '-'); } + /** + * Convert string to latin + * + * @param string $data The data string + * @return ?string The slugged data + */ + function latin(?string $data): ?string { + //With null + if ($data === null) { + //Return null + return $data; + } + + //Use Transliterator if available + if (class_exists('Transliterator')) { + //Convert from any to latin, then to ascii and lowercase + $trans = \Transliterator::create('Any-Latin; Latin-ASCII'); + //Replace every non alphanumeric character by dash then trim dash + return trim($trans->transliterate($data)); + } + + //Convert from utf-8 to ascii + return trim(iconv('UTF-8', 'ASCII//TRANSLIT', $data)); + } + /** * Unshort then unserialize * @@ -184,7 +210,7 @@ class SluggerUtil { */ public function unserialize(string $data): array { //Return unshorted unserialized string - return unserialize($this->unshort($data)); + return json_decode($this->unshort($data), true); } /**