1 <?php
declare(strict_types
=1);
4 * This file is part of the Rapsys PackBundle package.
6 * (c) Raphaël Gertz <symfony@rapsys.eu>
8 * For the full copyright and license information, please view the LICENSE
9 * file that was distributed with this source code.
12 namespace Rapsys\PackBundle\Util
;
15 * Manages string conversions
21 protected array $alpha;
29 * The alpha array key number
34 * The offset reduced from secret
36 protected int $offset;
39 * Construct slugger util
41 * TODO: use a recipe to generate in .env.local an env variable RAPSYSPACK_SECRET="ayl[...]z9w"
43 * @todo Add a command to generate alpha array or generate it on first run with cache storage ?
44 * @todo Use Cache like in calendar controller through FilesystemAdapter
46 * @param string $secret The secret string
48 public function __construct(protected string $secret) {
50 * Pseudo-random alphabet
51 * @xxx use array flip and keys to workaround php "smart" that cast range('0', '9') as int instead of string
52 * @xxx The key count mismatch, count(alpha)>count(rev), resulted in a data corruption due to duplicate numeric values
53 * @todosee required range by json_encode result and short input (0->255 ???)
55 $this->alpha
= array_keys(array_flip(array_merge(
82 $this->count = count($rev = $this->rev = array_flip($this->alpha));
85 $split = str_split($this->secret);
88 $this->offset = array_reduce($split, function ($res, $a) use ($rev) { return $res += $rev[$a]; }, count($split)) % $this->count;
92 * Flatten recursively an array
94 * @param array|string $data The data tree
95 * @param string|null $current The current prefix
96 * @param string $sep The key separator
97 * @param string $prefix The key prefix
98 * @param string $suffix The key suffix
99 * @return array The flattened data
101 public function flatten($data, ?string $current = null, string $sep = '.', string $prefix = '', string $suffix = ''): array {
105 //Look for data array
106 if (is_array($data)) {
107 //Iteare on each pair
108 foreach($data as $k => $v) {
109 //Merge flattened value in return array
110 $ret += $this->flatten($v, empty($current) ? $k : $current.$sep.$k, $sep, $prefix, $suffix);
114 //Store data in flattened key
115 $ret[$prefix.$current.$suffix] = $data;
123 * Crypt and base64uri encode string
125 * @param array|string $data The data string
126 * @return string The hashed data
128 public function hash(array|string $data): string {
130 if (is_array($data)) {
132 $data = json_encode($data);
136 //XXX: we use hash_hmac with md5 hash
137 //XXX: crypt was dropped because it provided identical signature for string starting with same pattern
138 return str_replace(['+
','/'], ['-','_
'], base64_encode(hash_hmac('md5
', $data, $this->secret, true)));
142 * Serialize then short
144 * @param array $data The data array
145 * @return string The serialized and shorted data
147 public function serialize(array $data): string {
148 //Return shorted serialized data
149 //XXX: dropped serialize use to prevent short function from dropping utf-8 characters
150 return $this->short(json_encode($data));
156 * @param string $data The data string
157 * @return string The shorted data
159 public function short(string $data): string {
165 //Iterate on each character
166 foreach(str_split($data) as $k => $c) {
167 if (isset($this->rev[$c]) && isset($this->alpha[($this->rev[$c]+$this->offset)%$this->count])) {
168 //XXX: Remap char to an other one
169 $ret .= chr(($this->rev[$c] - $this->offset + $this->count) % $this->count);
171 throw new \RuntimeException(sprintf('Unable to retrieve character
: %c
', $c));
177 return str_replace(['+
','/'], ['-','_
'], base64_encode($ret));
181 * Convert string to safe slug
183 * @param string $data The data string
184 * @return ?string The slugged data
186 function slug(?string $data): ?string {
188 if ($data === null) {
193 //Use Transliterator if available
194 if (class_exists('Transliterator
')) {
195 //Convert from any to latin, then to ascii and lowercase
196 $trans = \Transliterator::create('Any
-Latin
; Latin
-ASCII
; Lower()');
197 //Replace every non alphanumeric character by dash then trim dash
198 return trim(preg_replace('/[^a
-zA
-Z0
-9]+
/', '-', $trans->transliterate($data)), '-');
201 //Convert from utf-8 to ascii, replace quotes with space, remove non alphanumericseparator, replace separator with dash and trim dash
202 return trim(preg_replace('/[\
/_
|+ -]+
/', '-', strtolower(preg_replace('/[^a
-zA
-Z0
-9\
/_
|+ -]/', '', str_replace(['\'
', '"'], ' ', iconv('UTF-8', 'ASCII//TRANSLIT', $data))))), '-');
206 * Convert string to latin
208 * @param string $data The data string
209 * @return ?string The slugged data
211 function latin(?string $data): ?string {
213 if ($data === null) {
218 //Use Transliterator if available
219 if (class_exists('Transliterator')) {
220 //Convert from any to latin, then to ascii and lowercase
221 $trans = \Transliterator::create('Any-Latin; Latin-ASCII');
222 //Replace every non alphanumeric character by dash then trim dash
223 return trim($trans->transliterate($data));
226 //Convert from utf-8 to ascii
227 return trim(iconv('UTF-8', 'ASCII//TRANSLIT', $data));
231 * Unshort then unserialize
233 * @param string $data The data string
234 * @return array The unshorted and unserialized data
236 public function unserialize(string $data): array {
237 //Return unshorted unserialized string
238 return json_decode($this->unshort($data), true);
244 * @param string $data The data string
245 * @return string The unshorted data
247 public function unshort(string $data): string {
251 //Iterate on each character
252 foreach(str_split(base64_decode(str_replace(['-','_'], ['+','/'], $data))) as $c) {
253 //XXX: Reverse map char to an other one
254 $ret .= $this->alpha[(ord($c) + $this->offset) % $this->count];