nazar-pc /
CleverStyle-Framework
Complex classes like Data_and_files often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use Data_and_files, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 14 | trait Data_and_files { |
||
| 15 | /** |
||
| 16 | * Data array, similar to `$_POST` |
||
| 17 | * |
||
| 18 | * @var array |
||
| 19 | */ |
||
| 20 | public $data; |
||
| 21 | /** |
||
| 22 | * Normalized files array |
||
| 23 | * |
||
| 24 | * Each file item can be either single file or array of files (in contrast with native PHP arrays where each field like `name` become an array) with keys |
||
| 25 | * `name`, `type`, `size`, `tmp_name`, `stream` and `error` |
||
| 26 | * |
||
| 27 | * `name`, `type`, `size` and `error` keys are similar to native PHP fields in `$_FILES`; `tmp_name` might not be temporary file, but file descriptor |
||
| 28 | * wrapper like `request-file:///file` instead and `stream` is resource like obtained with `fopen('/tmp/xyz', 'rb')` |
||
| 29 | * |
||
| 30 | * @var array[] |
||
| 31 | */ |
||
| 32 | public $files; |
||
| 33 | /** |
||
| 34 | * Data stream resource, similar to `fopen('php://input', 'rb')` |
||
| 35 | * |
||
| 36 | * Make sure you're controlling position in stream where you read something, if code in some other place might seek on this stream |
||
| 37 | * |
||
| 38 | * Stream is read-only |
||
| 39 | * |
||
| 40 | * @var null|resource |
||
| 41 | */ |
||
| 42 | public $data_stream; |
||
| 43 | /** |
||
| 44 | * `$this->init_server()` assumed to be called already |
||
| 45 | * |
||
| 46 | * @param array $data Typically `$_POST` |
||
| 47 | * @param array[] $files Typically `$_FILES`; might be like native PHP array `$_FILES` or normalized; each file item MUST contain keys |
||
| 48 | * `name`, `type`, `size`, `error` and at least one of `tmp_name` or `stream` |
||
| 49 | * @param null|resource|string $data_stream String, like `php://input` or resource, like `fopen('php://input', 'rb')` with request body, will be parsed for |
||
| 50 | * data and files if necessary |
||
| 51 | * @param bool $copy_stream Sometimes data stream can only being read once (like most of times with `php://input`), so it is necessary to |
||
| 52 | * copy it and store its contents for longer period of time |
||
| 53 | * |
||
| 54 | * @throws ExitException |
||
| 55 | */ |
||
| 56 | 32 | function init_data_and_files ($data = [], $files = [], $data_stream = null, $copy_stream = true) { |
|
| 86 | /** |
||
| 87 | * Get data item by name |
||
| 88 | * |
||
| 89 | * @param string[]|string[][] $name |
||
| 90 | * |
||
| 91 | * @return mixed|mixed[]|null Data items (or associative array of data items) if exists or `null` otherwise (in case if `$name` is an array even one |
||
| 92 | * missing key will cause the whole thing to fail) |
||
| 93 | */ |
||
| 94 | 32 | function data (...$name) { |
|
| 114 | /** |
||
| 115 | * Get file item by name |
||
| 116 | * |
||
| 117 | * @param string $name |
||
| 118 | * |
||
| 119 | * @return array|null File item if exists or `null` otherwise |
||
| 120 | */ |
||
| 121 | 2 | function files ($name) { |
|
| 124 | /** |
||
| 125 | * @param array[] $files |
||
| 126 | * @param string $file_path |
||
| 127 | * |
||
| 128 | * @return array[] |
||
| 129 | */ |
||
| 130 | 32 | protected function normalize_files ($files, $file_path = '') { |
|
| 157 | /** |
||
| 158 | * @param array $file |
||
| 159 | * @param string $file_path |
||
| 160 | * |
||
| 161 | * @return array |
||
| 162 | */ |
||
| 163 | 2 | protected function normalize_file ($file, $file_path) { |
|
| 179 | /** |
||
| 180 | * Parsing request body for following Content-Type: `application/json`, `application/x-www-form-urlencoded` and `multipart/form-data` |
||
| 181 | * |
||
| 182 | * @throws ExitException |
||
| 183 | */ |
||
| 184 | 6 | protected function parse_data_stream () { |
|
| 185 | 6 | $content_type = $this->header('content-type'); |
|
| 186 | 6 | rewind($this->data_stream); |
|
| 187 | /** |
||
| 188 | * application/json |
||
| 189 | */ |
||
| 190 | 6 | if (preg_match('#^application/([^+\s]+\+)?json#', $content_type)) { |
|
| 191 | 2 | $this->data = _json_decode(stream_get_contents($this->data_stream)) ?: []; |
|
| 192 | 2 | return; |
|
| 193 | } |
||
| 194 | /** |
||
| 195 | * application/x-www-form-urlencoded |
||
| 196 | */ |
||
| 197 | 4 | if (strpos($content_type, 'application/x-www-form-urlencoded') === 0) { |
|
| 198 | 2 | @parse_str(stream_get_contents($this->data_stream), $this->data); |
|
| 199 | 2 | return; |
|
| 200 | } |
||
| 201 | /** |
||
| 202 | * multipart/form-data |
||
| 203 | */ |
||
| 204 | 2 | if (preg_match('#multipart/form-data;.*boundary="?([^;"]{1,70})(?:"|;|$)#Ui', $content_type, $matches)) { |
|
| 205 | try { |
||
| 206 | 2 | $parts = $this->parse_multipart_into_parts($this->data_stream, trim($matches[1])) ?: []; |
|
| 207 | list($this->data, $files) = $this->parse_multipart_analyze_parts($this->data_stream, $parts); |
||
| 208 | $this->files = $this->normalize_files($files); |
||
| 209 | 2 | } catch (UnexpectedValueException $e) { |
|
| 210 | // Do nothing, if parsing failed then we'll just leave `::$data` and `::$files` empty |
||
| 211 | } |
||
| 212 | } |
||
| 213 | 2 | } |
|
| 214 | /** |
||
| 215 | * Parse content stream |
||
| 216 | * |
||
| 217 | * @param resource $stream |
||
| 218 | * @param string $boundary |
||
| 219 | * |
||
| 220 | * @return array[]|false |
||
| 221 | * |
||
| 222 | * @throws UnexpectedValueException |
||
| 223 | * @throws ExitException |
||
| 224 | */ |
||
| 225 | 2 | protected function parse_multipart_into_parts ($stream, $boundary) { |
|
| 226 | 2 | $parts = []; |
|
| 227 | 2 | $crlf = "\r\n"; |
|
| 228 | 2 | $position = 0; |
|
| 229 | 2 | $body = ''; |
|
| 230 | 2 | list($offset, $body) = $this->parse_multipart_find($stream, $body, "--$boundary$crlf"); |
|
| 231 | /** |
||
| 232 | * strlen doesn't take into account trailing CRLF since we'll need it in loop below |
||
| 233 | */ |
||
| 234 | $position += $offset + strlen("--$boundary"); |
||
| 235 | $body = substr($body, strlen("--$boundary")); |
||
| 236 | /** |
||
| 237 | * Each part always starts with CRLF |
||
| 238 | */ |
||
| 239 | while (strpos($body, $crlf) === 0) { |
||
| 240 | $position += 2; |
||
| 241 | $body = substr($body, 2); |
||
| 242 | $part = [ |
||
| 243 | 'headers' => [ |
||
| 244 | 'offset' => $position, |
||
| 245 | 'size' => 0 |
||
| 246 | ], |
||
| 247 | 'body' => [ |
||
| 248 | 'offset' => 0, |
||
| 249 | 'size' => 0 |
||
| 250 | ] |
||
| 251 | ]; |
||
| 252 | if (strpos($body, $crlf) === 0) { |
||
| 253 | /** |
||
| 254 | * No headers |
||
| 255 | */ |
||
| 256 | $position += 2; |
||
| 257 | $body = substr($body, 2); |
||
| 258 | } else { |
||
| 259 | /** |
||
| 260 | * Find headers end in order to determine size |
||
| 261 | */ |
||
| 262 | list($offset, $body) = $this->parse_multipart_find($stream, $body, $crlf.$crlf); |
||
| 263 | $part['headers']['size'] = $offset; |
||
| 264 | $position += $offset + 4; |
||
| 265 | $body = substr($body, 4); |
||
| 266 | } |
||
| 267 | $part['body']['offset'] = $position; |
||
| 268 | /** |
||
| 269 | * Find body end in order to determine its size |
||
| 270 | */ |
||
| 271 | list($offset, $body) = $this->parse_multipart_find($stream, $body, "$crlf--$boundary"); |
||
| 272 | $part['body']['size'] = $offset; |
||
| 273 | $position += $offset + strlen("$crlf--$boundary"); |
||
| 274 | $body = substr($body, strlen("$crlf--$boundary")); |
||
| 275 | if ($part['headers']['size']) { |
||
| 276 | $parts[] = $part; |
||
| 277 | } |
||
| 278 | } |
||
| 279 | /** |
||
| 280 | * Last boundary after all parts ends with '--' and we don't care what rubbish happens after it |
||
| 281 | */ |
||
| 282 | $post_max_size = $this->post_max_size(); |
||
| 283 | if (0 !== strpos($body, '--')) { |
||
| 284 | return false; |
||
| 285 | } |
||
| 286 | /** |
||
| 287 | * Check whether body size is bigger than allowed limit |
||
| 288 | */ |
||
| 289 | if ($position + strlen($body) > $post_max_size) { |
||
| 290 | throw new ExitException(413); |
||
| 291 | } |
||
| 292 | return $parts; |
||
| 293 | } |
||
| 294 | /** |
||
| 295 | * @param resource $stream |
||
| 296 | * @param array[] $parts |
||
| 297 | * |
||
| 298 | * @return array[] |
||
| 299 | */ |
||
| 300 | protected function parse_multipart_analyze_parts ($stream, $parts) { |
||
| 345 | /** |
||
| 346 | * @return int |
||
| 347 | */ |
||
| 348 | protected function post_max_size () { |
||
| 352 | /** |
||
| 353 | * @return int |
||
| 354 | */ |
||
| 355 | protected function upload_max_file_size () { |
||
| 359 | /** |
||
| 360 | * @param int|string $size |
||
| 361 | * |
||
| 362 | * @return int |
||
| 363 | */ |
||
| 364 | protected function convert_size_to_bytes ($size) { |
||
| 375 | /** |
||
| 376 | * @param resource $stream |
||
| 377 | * @param string $next_data |
||
| 378 | * @param string $target |
||
| 379 | * |
||
| 380 | * @return array |
||
| 381 | * |
||
| 382 | * @throws UnexpectedValueException |
||
| 383 | */ |
||
| 384 | 2 | protected function parse_multipart_find ($stream, $next_data, $target) { |
|
| 385 | 2 | $offset = 0; |
|
| 386 | 2 | $prev_data = ''; |
|
| 387 | 2 | while (($found = strpos($prev_data.$next_data, $target)) === false) { |
|
| 388 | 2 | if (feof($stream)) { |
|
| 389 | 2 | throw new UnexpectedValueException; |
|
| 390 | } |
||
| 391 | 2 | if ($prev_data) { |
|
| 392 | $offset += strlen($prev_data); |
||
| 393 | } |
||
| 394 | 2 | $prev_data = $next_data; |
|
| 395 | 2 | $next_data = fread($stream, 1024); |
|
| 396 | } |
||
| 397 | $offset += $found; |
||
| 398 | /** |
||
| 399 | * Read some more bytes so that we'll always have some remainder in place, since empty remainder might cause problems with `strpos()` call later |
||
| 400 | */ |
||
| 401 | $remainder = substr($prev_data.$next_data, $found).(fread($stream, 1024) ?: ''); |
||
| 402 | return [$offset, $remainder]; |
||
| 403 | } |
||
| 404 | /** |
||
| 405 | * @param string $content |
||
| 406 | * |
||
| 407 | * @return array |
||
| 408 | */ |
||
| 409 | protected function parse_multipart_headers ($content) { |
||
| 431 | /** |
||
| 432 | * @param array $source |
||
| 433 | * @param string $name |
||
| 434 | * @param array|string $value |
||
| 435 | */ |
||
| 436 | protected function parse_multipart_set_target (&$source, $name, $value) { |
||
| 453 | } |
||
| 454 |
