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 JodelAccount 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 JodelAccount, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 3 | class JodelAccount |
||
|
|
|||
| 4 | { |
||
| 5 | public $accessToken; |
||
| 6 | public $expirationDate; |
||
| 7 | public $refreshToken; |
||
| 8 | public $distinctId; |
||
| 9 | public $deviceUid; |
||
| 10 | |||
| 11 | //is the Account a Bot or Spider? |
||
| 12 | public $isBot; |
||
| 13 | |||
| 14 | // array of voted Jodels |
||
| 15 | public $votes; |
||
| 16 | |||
| 17 | //Location of the Account |
||
| 18 | public $location; |
||
| 19 | |||
| 20 | function __construct($deviceUid = NULL, $isBot = FALSE) |
||
| 21 | { |
||
| 22 | if($deviceUid == NULL) |
||
| 23 | { |
||
| 24 | $this->deviceUid = $this->createAccount(); |
||
| 25 | } |
||
| 26 | else |
||
| 27 | { |
||
| 28 | $this->deviceUid = $deviceUid; |
||
| 29 | } |
||
| 30 | |||
| 31 | $this->isBot = $isBot; |
||
| 32 | $this->location = $this->getLocation(); |
||
| 33 | |||
| 34 | if(!$this->isTokenFresh()) |
||
| 35 | { |
||
| 36 | $this->refreshToken(); |
||
| 37 | } |
||
| 38 | $this->accessToken = $this->getAccessToken(); |
||
| 39 | } |
||
| 40 | |||
| 41 | function isAccountVerified() |
||
| 42 | { |
||
| 43 | $accountCreator = new GetUserConfig(); |
||
| 44 | $accountCreator->setAccessToken($this->accessToken); |
||
| 45 | $data = $accountCreator->execute(); |
||
| 46 | |||
| 47 | return $data['verified']; |
||
| 48 | } |
||
| 49 | |||
| 50 | function locationEquals($city) |
||
| 51 | { |
||
| 52 | $url = 'https://maps.googleapis.com/maps/api/geocode/json?address=' . htmlspecialchars($city) . '&key=AIzaSyCwhnja-or07012HqrhPW7prHEDuSvFT4w'; |
||
| 53 | $result = Requests::post($url); |
||
| 54 | if(json_decode($result->body, true)['status'] == 'ZERO_RESULTS' || json_decode($result->body, true)['status'] == 'INVALID_REQUEST') |
||
| 55 | { |
||
| 56 | error_log('Error locationEquals'); |
||
| 57 | return FALSE; |
||
| 58 | } |
||
| 59 | else |
||
| 60 | { |
||
| 61 | $name = json_decode($result->body, true)['results']['0']['address_components']['0']['long_name']; |
||
| 62 | $lat = json_decode($result->body, true)['results']['0']['geometry']['location']['lat']; |
||
| 63 | $lng = json_decode($result->body, true)['results']['0']['geometry']['location']['lng']; |
||
| 64 | } |
||
| 65 | |||
| 66 | $db = new DatabaseConnect(); |
||
| 67 | $result = $db->query("SELECT * FROM accounts WHERE device_uid='" . $this->deviceUid . "'"); |
||
| 68 | |||
| 69 | $location = new Location(); |
||
| 70 | |||
| 71 | if ($result->num_rows > 0) |
||
| 72 | { |
||
| 73 | // output data of each row |
||
| 74 | while($row = $result->fetch_assoc()) |
||
| 75 | { |
||
| 76 | $location->setLat($row['lat']); |
||
| 77 | $location->setLng($row['lng']); |
||
| 78 | $location->setCityName($row['name']); |
||
| 79 | } |
||
| 80 | } |
||
| 81 | else |
||
| 82 | { |
||
| 83 | echo "Error: 0 results"; |
||
| 84 | error_log("Error no Location found - getLocation"); |
||
| 85 | } |
||
| 86 | |||
| 87 | if($location->getLat() == $lat && $location->getLng() == $lng && $location->getCityName() == $name) |
||
| 88 | { |
||
| 89 | return TRUE; |
||
| 90 | } |
||
| 91 | else |
||
| 92 | { |
||
| 93 | return FALSE; |
||
| 94 | } |
||
| 95 | } |
||
| 96 | |||
| 97 | function setLocation() |
||
| 98 | { |
||
| 99 | //Is Channel or City |
||
| 100 | if(substr($_GET['city'], 0, 1) === '#') |
||
| 101 | { |
||
| 102 | return htmlspecialchars($_GET['city']) . " " . $this->location->cityName; |
||
| 103 | } |
||
| 104 | else |
||
| 105 | { |
||
| 106 | $url = 'https://maps.googleapis.com/maps/api/geocode/json?address=' . htmlspecialchars($_GET['city']) . '&key=AIzaSyCwhnja-or07012HqrhPW7prHEDuSvFT4w'; |
||
| 107 | $result = Requests::post($url); |
||
| 108 | if(json_decode($result->body, true)['status'] == 'ZERO_RESULTS' || json_decode($result->body, true)['status'] == 'INVALID_REQUEST') |
||
| 109 | { |
||
| 110 | return "0 results"; |
||
| 111 | } |
||
| 112 | else |
||
| 113 | { |
||
| 114 | $name = json_decode($result->body, true)['results']['0']['address_components']['0']['long_name']; |
||
| 115 | $lat = json_decode($result->body, true)['results']['0']['geometry']['location']['lat']; |
||
| 116 | $lng = json_decode($result->body, true)['results']['0']['geometry']['location']['lng']; |
||
| 117 | |||
| 118 | $location = new Location(); |
||
| 119 | $location->setLat($lat); |
||
| 120 | $location->setLng($lng); |
||
| 121 | $location->setCityName($name); |
||
| 122 | $accountCreator = new UpdateLocation(); |
||
| 123 | $accountCreator->setLocation($location); |
||
| 124 | $accountCreator->setAccessToken($this->accessToken); |
||
| 125 | $data = $accountCreator->execute(); |
||
| 126 | |||
| 127 | //safe location to db |
||
| 128 | $db = new DatabaseConnect(); |
||
| 129 | |||
| 130 | if($data == 'Success') |
||
| 131 | { |
||
| 132 | $result = $db->query("UPDATE accounts |
||
| 133 | SET name='" . $name . "', |
||
| 134 | lat='" . $lat . "', |
||
| 135 | lng='" . $lng . "' |
||
| 136 | WHERE access_token='" . $this->accessToken . "'"); |
||
| 137 | |||
| 138 | if($result === false) |
||
| 139 | { |
||
| 140 | echo "Updating location failed: (" . $db->errno . ") " . $db->error; |
||
| 141 | } |
||
| 142 | else |
||
| 143 | { |
||
| 144 | error_log('User with JodelDeviceId:' . $this->deviceUid . ' [' . $_SERVER['REMOTE_ADDR'] . '][' . $_SERVER ['HTTP_USER_AGENT'] . '] changed to Location: ' . $name); |
||
| 145 | } |
||
| 146 | } |
||
| 147 | |||
| 148 | return $name; |
||
| 149 | } |
||
| 150 | } |
||
| 151 | } |
||
| 152 | |||
| 153 | function getLocation() |
||
| 154 | { |
||
| 155 | $db = new DatabaseConnect(); |
||
| 156 | $result = $db->query("SELECT * FROM accounts WHERE device_uid='" . $this->deviceUid . "'"); |
||
| 157 | |||
| 158 | $location = new Location(); |
||
| 159 | |||
| 160 | if ($result->num_rows > 0) |
||
| 161 | { |
||
| 162 | // output data of each row |
||
| 163 | while($row = $result->fetch_assoc()) |
||
| 164 | { |
||
| 165 | $location->setLat($row['lat']); |
||
| 166 | $location->setLng($row['lng']); |
||
| 167 | $location->setCityName($row['name']); |
||
| 168 | } |
||
| 169 | } |
||
| 170 | else |
||
| 171 | { |
||
| 172 | echo "Error: 0 results"; |
||
| 173 | error_log("Error no Location found - getLocation"); |
||
| 174 | } |
||
| 175 | |||
| 176 | return $location; |
||
| 177 | } |
||
| 178 | |||
| 179 | function verifyCaptcha() |
||
| 180 | { |
||
| 181 | if(isset($_GET['deviceUid'])) |
||
| 182 | { |
||
| 183 | $deviceUid = $_GET['deviceUid']; |
||
| 184 | } |
||
| 185 | if(isset($_POST['deviceUid'])) |
||
| 186 | { |
||
| 187 | $deviceUid = $_POST['deviceUid']; |
||
| 188 | } |
||
| 189 | $jodelAccountForVerify = new JodelAccount($deviceUid); |
||
| 190 | |||
| 191 | $solution = $_GET['solution']; |
||
| 192 | $solution = array_map('intval', explode('-', $solution)); |
||
| 193 | |||
| 194 | $accountCreator = new PostCaptcha(); |
||
| 195 | $accountCreator->setAccessToken($jodelAccountForVerify->accessToken); |
||
| 196 | $accountCreator->captchaKey = $_GET['key']; |
||
| 197 | $accountCreator->captchaSolution = $solution; |
||
| 198 | $verified = $accountCreator->execute(); |
||
| 199 | |||
| 200 | if(isset($verified->status_code)) |
||
| 201 | { |
||
| 202 | return $verified->status_code; |
||
| 203 | } |
||
| 204 | return $verified['verified']; |
||
| 205 | } |
||
| 206 | |||
| 207 | //ToDo Spider Check |
||
| 208 | function votePostId($postId, $vote) |
||
| 209 | { |
||
| 210 | if(!$this->isAccountVerified()) |
||
| 211 | { |
||
| 212 | $view = new View(); |
||
| 213 | $view->showCaptcha($this->accessToken, $this->deviceUid); |
||
| 214 | } |
||
| 215 | |||
| 216 | if(!$this->hasVoted($postId)) |
||
| 217 | { |
||
| 218 | if($vote == "up") |
||
| 219 | { |
||
| 220 | $accountCreator = new Upvote(); |
||
| 221 | } |
||
| 222 | else if($vote == "down") |
||
| 223 | { |
||
| 224 | $accountCreator = new Downvote(); |
||
| 225 | } |
||
| 226 | $accountCreator->setAccessToken($this->accessToken); |
||
| 227 | $accountCreator->postId = htmlspecialchars($postId); |
||
| 228 | $data = $accountCreator->execute(); |
||
| 229 | |||
| 230 | if(array_key_exists('post', $data)) |
||
| 231 | { |
||
| 232 | $this->addVoteWithPostIdAndType($postId, $vote); |
||
| 233 | return TRUE; |
||
| 234 | } |
||
| 235 | else |
||
| 236 | { |
||
| 237 | error_log("Could not vote: " . var_dump($data)); |
||
| 238 | return FALSE; |
||
| 239 | } |
||
| 240 | } |
||
| 241 | else |
||
| 242 | { |
||
| 243 | return FALSE; |
||
| 244 | } |
||
| 245 | } |
||
| 246 | |||
| 247 | //ToDo Spider Check |
||
| 248 | function sendJodel($location, $view) |
||
| 249 | { |
||
| 250 | if(!$this->isAccountVerified()) |
||
| 251 | { |
||
| 252 | showCaptcha($this->accessToken); |
||
| 253 | } |
||
| 254 | |||
| 255 | $accountCreator = new SendJodel(); |
||
| 256 | |||
| 257 | if(isset($_POST['ancestor'])) |
||
| 258 | { |
||
| 259 | $ancestor = $_POST['ancestor']; |
||
| 260 | $accountCreator->ancestor = $ancestor; |
||
| 261 | } |
||
| 262 | if(isset($_POST['color'])) |
||
| 263 | { |
||
| 264 | $color = $_POST['color']; |
||
| 265 | switch ($color) { |
||
| 266 | case '8ABDB0': |
||
| 267 | $color = '8ABDB0'; |
||
| 268 | break; |
||
| 269 | case '9EC41C': |
||
| 270 | $color = '9EC41C'; |
||
| 271 | break; |
||
| 272 | case '06A3CB': |
||
| 273 | $color = '06A3CB'; |
||
| 274 | break; |
||
| 275 | case 'FFBA00': |
||
| 276 | $color = 'FFBA00'; |
||
| 277 | break; |
||
| 278 | case 'DD5F5F': |
||
| 279 | $color = 'DD5F5F'; |
||
| 280 | break; |
||
| 281 | case 'FF9908': |
||
| 282 | $color = 'FF9908'; |
||
| 283 | break; |
||
| 284 | default: |
||
| 285 | $color = '8ABDB0'; |
||
| 286 | break; |
||
| 287 | } |
||
| 288 | $accountCreator->color = $color; |
||
| 289 | } |
||
| 290 | |||
| 291 | $accountCreatorLocation = new UpdateLocation(); |
||
| 292 | $accountCreatorLocation->setLocation($location); |
||
| 293 | $accountCreatorLocation->setAccessToken($this->accessToken); |
||
| 294 | $data = $accountCreatorLocation->execute(); |
||
| 295 | |||
| 296 | $accountCreator->location = $this->location; |
||
| 297 | |||
| 298 | $accountCreator->setAccessToken($this->accessToken); |
||
| 299 | $data = $accountCreator->execute(); |
||
| 300 | |||
| 301 | if(isset($_POST['ancestor'])) |
||
| 302 | { |
||
| 303 | header('Location: ' . $view->toUrl(); |
||
| 304 | exit; |
||
| 305 | } |
||
| 306 | else |
||
| 307 | { |
||
| 308 | header('Location: ' . $baseUrl); |
||
| 309 | exit; |
||
| 310 | } |
||
| 311 | } |
||
| 312 | |||
| 313 | function isTokenFresh() |
||
| 314 | { |
||
| 315 | $db = new DatabaseConnect(); |
||
| 316 | $result = $db->query("SELECT * FROM accounts WHERE device_uid='" . $this->deviceUid . "'"); |
||
| 317 | |||
| 318 | if ($result->num_rows > 0) |
||
| 319 | { |
||
| 320 | // output data of each row |
||
| 321 | while($row = $result->fetch_assoc()) |
||
| 322 | { |
||
| 323 | $expiration_date = $row["expiration_date"]; |
||
| 324 | } |
||
| 325 | } |
||
| 326 | else |
||
| 327 | { |
||
| 328 | error_log('0 results'); |
||
| 329 | } |
||
| 330 | |||
| 331 | if($expiration_date <= time()) |
||
| 332 | { |
||
| 333 | return FALSE; |
||
| 334 | } |
||
| 335 | |||
| 336 | return TRUE; |
||
| 337 | } |
||
| 338 | |||
| 339 | function refreshToken() |
||
| 340 | { |
||
| 341 | $accountCreator = new CreateUser(); |
||
| 342 | $accountCreator->setAccessToken($this->accessToken); |
||
| 343 | $accountCreator->setDeviceUid($this->deviceUid); |
||
| 344 | $accountCreator->setLocation($this->location); |
||
| 345 | $data = $accountCreator->execute(); |
||
| 346 | |||
| 347 | $access_token = (string)$data[0]['access_token']; |
||
| 348 | $expiration_date = $data[0]['expiration_date']; |
||
| 349 | $device_uid = (string)$data[1]; |
||
| 350 | |||
| 351 | $db = new DatabaseConnect(); |
||
| 352 | $result = $db->query("UPDATE accounts |
||
| 353 | SET access_token='" . $access_token . "', |
||
| 354 | expiration_date='" . $expiration_date . "' |
||
| 355 | WHERE device_uid='" . $device_uid . "'"); |
||
| 356 | |||
| 357 | if($result === false){ |
||
| 358 | error_log("Adding account failed: (" . $db->errno . ") " . $db->error); |
||
| 359 | } |
||
| 360 | } |
||
| 361 | |||
| 362 | |||
| 363 | |||
| 364 | function getAccessToken() |
||
| 365 | { |
||
| 366 | $db = new DatabaseConnect(); |
||
| 367 | $result = $db->query("SELECT * FROM accounts WHERE device_uid='" . $this->deviceUid . "'"); |
||
| 368 | |||
| 369 | $accessToken; |
||
| 370 | |||
| 371 | if ($result->num_rows > 0) |
||
| 372 | { |
||
| 373 | // output data of each row |
||
| 374 | while($row = $result->fetch_assoc()) |
||
| 375 | { |
||
| 376 | $accessToken = $row['access_token']; |
||
| 377 | } |
||
| 378 | } |
||
| 379 | else |
||
| 380 | { |
||
| 381 | error_log('Error: 0 results'); |
||
| 382 | } |
||
| 383 | |||
| 384 | return $accessToken; |
||
| 385 | } |
||
| 386 | |||
| 387 | |||
| 388 | function getKarma() |
||
| 389 | { |
||
| 390 | $accountCreator = new GetKarma(); |
||
| 391 | $accountCreator->setAccessToken($this->accessToken); |
||
| 392 | $data = $accountCreator->execute(); |
||
| 393 | |||
| 394 | return $data["karma"]; |
||
| 395 | } |
||
| 396 | |||
| 397 | function hasVoted($postId) |
||
| 398 | { |
||
| 399 | $db = new DatabaseConnect(); |
||
| 400 | |||
| 401 | $postId = $db->real_escape_string($postId); |
||
| 402 | |||
| 403 | $result = $db->query("SELECT id FROM votes WHERE (postId = '" . $postId . "' AND device_uid = '" . $this->deviceUid . "')"); |
||
| 404 | |||
| 405 | if($result === false) |
||
| 406 | { |
||
| 407 | $error = db_error(); |
||
| 408 | echo $error; |
||
| 409 | error_log("Adding Vote failed: (" . $result->errno . ") " . $result->error); |
||
| 410 | } |
||
| 411 | |||
| 412 | if($result->num_rows == 0) |
||
| 413 | { |
||
| 414 | return FALSE; |
||
| 415 | } |
||
| 416 | else |
||
| 417 | { |
||
| 418 | return TRUE; |
||
| 419 | } |
||
| 420 | } |
||
| 421 | |||
| 422 | function addVoteWithPostIdAndType($postId, $voteType) |
||
| 423 | { |
||
| 424 | $db = new DatabaseConnect(); |
||
| 425 | |||
| 426 | $postId = $db->real_escape_string($postId); |
||
| 427 | $voteType = $db->real_escape_string($voteType); |
||
| 428 | |||
| 429 | if($this->hasVoted($postId)) |
||
| 430 | { |
||
| 431 | return "Already voted"; |
||
| 432 | } |
||
| 433 | |||
| 434 | $result = $db->query("INSERT INTO votes (device_uid, postId, type) |
||
| 435 | VALUES ('" . $this->deviceUid . "','" . $postId . "','" . $voteType . "')"); |
||
| 436 | |||
| 437 | if($result === false){ |
||
| 438 | $error = db_error(); |
||
| 439 | echo $error; |
||
| 440 | echo "Adding Vote failed: (" . $result->errno . ") " . $result->error; |
||
| 441 | } |
||
| 442 | } |
||
| 443 | |||
| 444 | function registerAccount($location) { |
||
| 445 | $accountCreator = new CreateUser(); |
||
| 446 | $accountCreator->setLocation($location); |
||
| 447 | $data = $accountCreator->execute(); |
||
| 448 | |||
| 449 | $access_token = (string)$data[0]['access_token']; |
||
| 450 | $refresh_token = (string)$data[0]['refresh_token']; |
||
| 451 | $token_type = (string)$data[0]['token_type']; |
||
| 452 | $expires_in = $data[0]['expires_in']; |
||
| 453 | $expiration_date = $data[0]['expiration_date']; |
||
| 454 | $distinct_id = (string)$data[0]['distinct_id']; |
||
| 455 | $device_uid = (string)$data[1]; |
||
| 456 | |||
| 457 | $name = $location->cityName; |
||
| 458 | $lat = $location->lat; |
||
| 459 | $lng = $location->lng; |
||
| 460 | |||
| 461 | $db = new DatabaseConnect(); |
||
| 462 | $result = $db->query("INSERT INTO accounts (access_token, refresh_token, token_type, |
||
| 463 | expires_in, expiration_date, distinct_id, device_uid, name, lat, lng) |
||
| 464 | VALUES ('" . $access_token . "','" . $refresh_token . "','" . $token_type . |
||
| 465 | "','" . $expires_in . "','" . $expiration_date . "','" . $distinct_id . |
||
| 466 | "','" . $device_uid . "','" . $name . "','" . $lat . "','" . $lng . "') "); |
||
| 467 | |||
| 468 | $success = TRUE; |
||
| 469 | if($result === false){ |
||
| 470 | $error = db_error(); |
||
| 471 | echo $error; |
||
| 472 | echo "Adding account failed: (" . $result->errno . ") " . $result->error; |
||
| 473 | $success = FALSE; |
||
| 474 | } |
||
| 475 | |||
| 476 | return $device_uid; |
||
| 477 | } |
||
| 478 | |||
| 479 | function createAccount() |
||
| 480 | { |
||
| 481 | $config = parse_ini_file('config/config.ini.php'); |
||
| 482 | $location = new Location(); |
||
| 483 | $location->setLat($config['default_lat']); |
||
| 484 | $location->setLng($config['default_lng']); |
||
| 485 | $location->setCityName($config['default_location']); |
||
| 486 | |||
| 487 | $deviceUid = $this->registerAccount($location); |
||
| 488 | |||
| 489 | return $deviceUid; |
||
| 490 | } |
||
| 491 | } |
You can fix this by adding a namespace to your class:
When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries.