Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
Complex classes like BaseRequest 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 BaseRequest, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 12 | class BaseRequest |
||
| 13 | { |
||
| 14 | private $scheme; |
||
| 15 | private $user; |
||
| 16 | private $pass; |
||
| 17 | private $host; |
||
| 18 | private $port; |
||
| 19 | private $path; |
||
| 20 | private $query = array(); |
||
| 21 | |||
| 22 | /** @var [string => string] */ |
||
| 23 | private $headers = array(); |
||
| 24 | |||
| 25 | private $capath; |
||
| 26 | private $cafile; |
||
| 27 | |||
| 28 | protected static $defaultCurlOptions = array(); |
||
| 29 | |||
| 30 | private static $NSS_CIPHERS = array( |
||
| 31 | 'rsa_3des_sha', |
||
| 32 | 'rsa_des_sha', |
||
| 33 | 'rsa_null_md5', |
||
| 34 | 'rsa_null_sha', |
||
| 35 | 'rsa_rc2_40_md5', |
||
| 36 | 'rsa_rc4_128_md5', |
||
| 37 | 'rsa_rc4_128_sha', |
||
| 38 | 'rsa_rc4_40_md5', |
||
| 39 | 'fips_des_sha', |
||
| 40 | 'fips_3des_sha', |
||
| 41 | 'rsa_des_56_sha', |
||
| 42 | 'rsa_rc4_56_sha', |
||
| 43 | 'rsa_aes_128_sha', |
||
| 44 | 'rsa_aes_256_sha', |
||
| 45 | 'rsa_aes_128_gcm_sha_256', |
||
| 46 | 'dhe_rsa_aes_128_gcm_sha_256', |
||
| 47 | 'ecdh_ecdsa_null_sha', |
||
| 48 | 'ecdh_ecdsa_rc4_128_sha', |
||
| 49 | 'ecdh_ecdsa_3des_sha', |
||
| 50 | 'ecdh_ecdsa_aes_128_sha', |
||
| 51 | 'ecdh_ecdsa_aes_256_sha', |
||
| 52 | 'ecdhe_ecdsa_null_sha', |
||
| 53 | 'ecdhe_ecdsa_rc4_128_sha', |
||
| 54 | 'ecdhe_ecdsa_3des_sha', |
||
| 55 | 'ecdhe_ecdsa_aes_128_sha', |
||
| 56 | 'ecdhe_ecdsa_aes_256_sha', |
||
| 57 | 'ecdh_rsa_null_sha', |
||
| 58 | 'ecdh_rsa_128_sha', |
||
| 59 | 'ecdh_rsa_3des_sha', |
||
| 60 | 'ecdh_rsa_aes_128_sha', |
||
| 61 | 'ecdh_rsa_aes_256_sha', |
||
| 62 | 'ecdhe_rsa_rc4_128_sha', |
||
| 63 | 'ecdhe_rsa_3des_sha', |
||
| 64 | 'ecdhe_rsa_aes_128_sha', |
||
| 65 | 'ecdhe_rsa_aes_256_sha', |
||
| 66 | 'ecdhe_ecdsa_aes_128_gcm_sha_256', |
||
| 67 | 'ecdhe_rsa_aes_128_gcm_sha_256', |
||
| 68 | ); |
||
| 69 | |||
| 70 | /** |
||
| 71 | * enable ECC cipher suites in cURL/NSS |
||
| 72 | * @codeCoverageIgnore |
||
| 73 | */ |
||
| 74 | public static function nssCiphers() |
||
| 86 | |||
| 87 | 4 | protected function getProxy($url) |
|
| 113 | |||
| 114 | /** |
||
| 115 | * @param $io |
||
| 116 | * @param bool $useRedirector |
||
| 117 | * @param $githubDomains |
||
| 118 | * @param $gitlabDomains |
||
| 119 | */ |
||
| 120 | 6 | protected function setupAuthentication(IO\IOInterface $io, $useRedirector, array $githubDomains, array $gitlabDomains) |
|
| 167 | |||
| 168 | /** |
||
| 169 | * @return array |
||
| 170 | */ |
||
| 171 | 4 | public function getCurlOptions() |
|
| 172 | { |
||
| 173 | 4 | $headers = array(); |
|
| 174 | 4 | foreach ($this->headers as $key => $val) { |
|
| 175 | 1 | $headers[] = strtr(ucwords(strtr($key, '-', ' ')), ' ', '-') . ': ' . $val; |
|
| 176 | } |
||
| 177 | |||
| 178 | 4 | $url = $this->getURL(); |
|
| 179 | |||
| 180 | $curlOpts = array( |
||
| 181 | 4 | CURLOPT_URL => $url, |
|
| 182 | 4 | CURLOPT_HTTPHEADER => $headers, |
|
| 183 | 4 | CURLOPT_USERAGENT => ConfigFacade::getUserAgent(), |
|
| 184 | //CURLOPT_VERBOSE => true, //for debug |
||
| 185 | ); |
||
| 186 | 4 | $curlOpts += static::$defaultCurlOptions; |
|
| 187 | |||
| 188 | // @codeCoverageIgnoreStart |
||
| 189 | if ($ciphers = $this->nssCiphers()) { |
||
| 190 | $curlOpts[CURLOPT_SSL_CIPHER_LIST] = $ciphers; |
||
| 191 | } |
||
| 192 | // @codeCoverageIgnoreEnd |
||
| 193 | 4 | if ($proxy = $this->getProxy($url)) { |
|
| 194 | 1 | $curlOpts[CURLOPT_PROXY] = $proxy; |
|
| 195 | } |
||
| 196 | 4 | if ($this->capath) { |
|
| 197 | 1 | $curlOpts[CURLOPT_CAPATH] = $this->capath; |
|
| 198 | } |
||
| 199 | 4 | if ($this->cafile) { |
|
| 200 | 1 | $curlOpts[CURLOPT_CAINFO] = $this->cafile; |
|
| 201 | } |
||
| 202 | |||
| 203 | // TODO replace with a proper http2 server side feature detect |
||
| 204 | // e.g. codeload.github.com does not yet support http2 though :-/ |
||
| 205 | 4 | $h2ServerSupported = false; |
|
| 206 | $hostsWhichSupportHttp2 = array( |
||
| 207 | 4 | "gitlab.com", |
|
| 208 | "repo.packagist.org" |
||
| 209 | ); |
||
| 210 | 4 | foreach($hostsWhichSupportHttp2 as $http2Host) { |
|
| 211 | // http2 requires https |
||
| 212 | 4 | if (preg_match('{^https://'. preg_quote($http2Host) .'}i', $url)) { |
|
| 213 | 1 | $h2ServerSupported = true; |
|
| 214 | 4 | break; |
|
| 215 | } |
||
| 216 | } |
||
| 217 | |||
| 218 | // feature detect http2 support in the php client/curl version. |
||
| 219 | 4 | $h2ClientSupported = false; |
|
| 220 | 4 | if (defined('CURL_VERSION_HTTP2')) { |
|
| 221 | 4 | $curlVersion = curl_version(); |
|
| 222 | 4 | $h2ClientSupported = $curlVersion["features"] & CURL_VERSION_HTTP2 !== 0; |
|
| 223 | } |
||
| 224 | |||
| 225 | 4 | if ($h2ServerSupported && $h2ClientSupported) { |
|
| 226 | 1 | $curlOpts[CURLOPT_HTTP_VERSION] = CURL_HTTP_VERSION_2_0; |
|
| 227 | } |
||
| 228 | |||
| 229 | 4 | return $curlOpts; |
|
| 230 | } |
||
| 231 | |||
| 232 | /** |
||
| 233 | * @return string |
||
| 234 | */ |
||
| 235 | 7 | public function getURL() |
|
| 236 | { |
||
| 237 | 7 | $url = self::ifOr($this->scheme, '', '://'); |
|
| 238 | 7 | if ($this->user) { |
|
| 239 | 1 | $user = $this->user; |
|
| 240 | 1 | $user .= self::ifOr($this->pass, ':'); |
|
| 241 | 1 | $url .= $user . '@'; |
|
| 242 | } |
||
| 243 | 7 | $url .= self::ifOr($this->host); |
|
| 244 | 7 | $url .= self::ifOr($this->port, ':'); |
|
| 245 | 7 | $url .= self::ifOr($this->path); |
|
| 246 | 7 | $url .= self::ifOr(http_build_query($this->query), '?'); |
|
| 247 | 7 | return $url; |
|
| 248 | } |
||
| 249 | |||
| 250 | /** |
||
| 251 | * @return string user/pass/access_token masked url |
||
| 252 | */ |
||
| 253 | 1 | View Code Duplication | public function getMaskedURL() |
| 261 | |||
| 262 | /** |
||
| 263 | * @return string |
||
| 264 | */ |
||
| 265 | 2 | View Code Duplication | public function getOriginURL() |
| 272 | |||
| 273 | 9 | private static function ifOr($str, $pre = '', $post = '') |
|
| 280 | |||
| 281 | /** |
||
| 282 | * @param string $url |
||
| 283 | */ |
||
| 284 | 11 | public function setURL($url) |
|
| 285 | { |
||
| 286 | 11 | $struct = parse_url($url); |
|
| 287 | 11 | foreach ($struct as $key => $val) { |
|
| 288 | 11 | if ($key === 'query') { |
|
| 289 | 4 | parse_str($val, $this->query); |
|
| 290 | } else { |
||
| 291 | 11 | $this->$key = $val; |
|
| 292 | } |
||
| 293 | } |
||
| 294 | 11 | } |
|
| 295 | |||
| 296 | 1 | public function addParam($key, $val) |
|
| 300 | |||
| 301 | 1 | public function addHeader($key, $val) |
|
| 305 | |||
| 306 | 7 | public function setCA($path = null, $file = null) |
|
| 311 | |||
| 312 | 1 | public function isHTTP() |
|
| 316 | } |
||
| 317 |
Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: