ovidiul /
XCloner-Wordpress
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 Xcloner_Encryption 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 Xcloner_Encryption, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 11 | class Xcloner_Encryption |
||
| 12 | { |
||
| 13 | const FILE_ENCRYPTION_BLOCKS = 1024 * 1024; |
||
| 14 | const FILE_ENCRYPTION_SUFFIX = ".encrypted"; |
||
| 15 | const FILE_DECRYPTION_SUFFIX = ".decrypted"; |
||
| 16 | |||
| 17 | private $xcloner_settings; |
||
| 18 | private $logger; |
||
| 19 | private $verification = false; |
||
| 20 | |||
| 21 | public function __construct(Xcloner $xcloner_container) |
||
| 22 | { |
||
| 23 | $this->xcloner_container = $xcloner_container; |
||
|
Bug
Best Practice
introduced
by
|
|||
| 24 | if (method_exists($xcloner_container, 'get_xcloner_settings')) { |
||
| 25 | $this->xcloner_settings = $xcloner_container->get_xcloner_settings(); |
||
| 26 | } else { |
||
| 27 | $this->xcloner_settings = ""; |
||
| 28 | } |
||
| 29 | |||
| 30 | if (method_exists($xcloner_container, 'get_xcloner_logger')) { |
||
| 31 | $this->logger = $xcloner_container->get_xcloner_logger()->withName("xcloner_encryption"); |
||
| 32 | } else { |
||
| 33 | $this->logger = ""; |
||
| 34 | } |
||
| 35 | } |
||
| 36 | |||
| 37 | /** |
||
| 38 | * Returns the backup encryption key |
||
| 39 | * |
||
| 40 | * @return SECURE_AUTH_SALT|null |
||
| 41 | */ |
||
| 42 | public function get_backup_encryption_key() |
||
| 43 | { |
||
| 44 | if (is_object($this->xcloner_settings)) { |
||
| 45 | return $this->xcloner_settings->get_xcloner_encryption_key(); |
||
| 46 | } |
||
| 47 | |||
| 48 | return ""; |
||
| 49 | |||
| 50 | } |
||
| 51 | |||
| 52 | /** |
||
| 53 | * Check if provided filename has encrypted suffix |
||
| 54 | * |
||
| 55 | * @param $filename |
||
| 56 | * @return bool |
||
| 57 | */ |
||
| 58 | public function is_encrypted_file($filename) { |
||
| 59 | $fp = fopen($this->get_xcloner_path().$filename, 'r'); |
||
| 60 | $encryption_length = fread($fp, 16); |
||
| 61 | fclose($fp); |
||
| 62 | if (is_numeric($encryption_length)) { |
||
| 63 | return true; |
||
| 64 | } |
||
| 65 | |||
| 66 | return false; |
||
| 67 | |||
| 68 | } |
||
| 69 | |||
| 70 | /** |
||
| 71 | * Returns the filename with encrypted suffix |
||
| 72 | * |
||
| 73 | * @param string $filename |
||
| 74 | * @return string |
||
| 75 | */ |
||
| 76 | public function get_encrypted_target_backup_file_name($filename) { |
||
| 77 | |||
| 78 | return str_replace(self::FILE_DECRYPTION_SUFFIX, "", $filename).self::FILE_ENCRYPTION_SUFFIX; |
||
| 79 | } |
||
| 80 | |||
| 81 | /** |
||
| 82 | * Returns the filename without encrypted suffix |
||
| 83 | * |
||
| 84 | * @param string $filename |
||
| 85 | * @return string |
||
| 86 | */ |
||
| 87 | public function get_decrypted_target_backup_file_name($filename) { |
||
| 88 | |||
| 89 | return str_replace(self::FILE_ENCRYPTION_SUFFIX, "", $filename).self::FILE_DECRYPTION_SUFFIX; |
||
| 90 | } |
||
| 91 | |||
| 92 | /** |
||
| 93 | * Encrypt the passed file and saves the result in a new file with ".enc" as suffix. |
||
| 94 | * |
||
| 95 | * @param string $source Path to file that should be encrypted |
||
| 96 | * @param string $dest File name where the encryped file should be written to. |
||
| 97 | * @param string $key The key used for the encryption |
||
| 98 | * @param int $start Start position for reading when doing incremental mode. |
||
| 99 | * @param integer $iv The IV key to use. |
||
| 100 | * @param bool $verification Weather we should we try to verify the decryption. |
||
| 101 | * @return string|false Returns the file name that has been created or FALSE if an error occured |
||
| 102 | */ |
||
| 103 | public function encrypt_file($source, $dest = "", $key = "", $start = 0, $iv = 0, $verification = true, $recursive = false) |
||
| 104 | { |
||
| 105 | if (is_object($this->logger)) { |
||
| 106 | $this->logger->info(sprintf('Encrypting file %s at position %d IV %s', $source, $start, base64_encode($iv))); |
||
| 107 | } |
||
| 108 | |||
| 109 | //$key = substr(sha1($key, true), 0, 16); |
||
| 110 | if (!$key) { |
||
| 111 | $key = self::get_backup_encryption_key(); |
||
| 112 | } |
||
| 113 | $key_digest = openssl_digest($key, "md5", true); |
||
| 114 | |||
| 115 | $keep_local = 1; |
||
| 116 | if (!$dest) { |
||
| 117 | $dest = $this->get_encrypted_target_backup_file_name($source); |
||
| 118 | $keep_local = 0; |
||
| 119 | } |
||
| 120 | |||
| 121 | if (!$iv || !$start) { |
||
| 122 | //$iv = openssl_random_pseudo_bytes(16); |
||
| 123 | $iv = str_pad(self::FILE_ENCRYPTION_BLOCKS, 16, "0000000000000000", STR_PAD_LEFT); |
||
| 124 | } |
||
| 125 | |||
| 126 | if (!$start) { |
||
| 127 | $fpOut = fopen($this->get_xcloner_path().$dest, 'w'); |
||
| 128 | } else { |
||
| 129 | $fpOut = fopen($this->get_xcloner_path().$dest, 'a'); |
||
| 130 | } |
||
| 131 | |||
| 132 | if ($fpOut) { |
||
| 133 | |||
| 134 | // Put the initialization vector to the beginning of the file |
||
| 135 | if (!$start) { |
||
| 136 | fwrite($fpOut, $iv); |
||
| 137 | } |
||
| 138 | |||
| 139 | if (file_exists($this->get_xcloner_path().$source) && |
||
| 140 | $fpIn = fopen($this->get_xcloner_path().$source, 'rb')) { |
||
| 141 | |||
| 142 | fseek($fpIn, (int)$start); |
||
| 143 | |||
| 144 | if (!feof($fpIn)) { |
||
| 145 | |||
| 146 | $plaintext = fread($fpIn, 16 * self::FILE_ENCRYPTION_BLOCKS); |
||
| 147 | $ciphertext = openssl_encrypt($plaintext, 'AES-128-CBC', $key_digest, OPENSSL_RAW_DATA, $iv); |
||
| 148 | |||
| 149 | // Use the first 16 bytes of the ciphertext as the next initialization vector |
||
| 150 | $iv = substr($ciphertext, 0, 16); |
||
| 151 | //$iv = openssl_random_pseudo_bytes(16); |
||
| 152 | |||
| 153 | fwrite($fpOut, $ciphertext); |
||
| 154 | |||
| 155 | $start = ftell($fpIn); |
||
| 156 | |||
| 157 | fclose($fpOut); |
||
| 158 | |||
| 159 | if (!feof($fpIn)) { |
||
| 160 | fclose($fpIn); |
||
| 161 | //echo "\n NEW:".$key.md5($iv); |
||
| 162 | //self::encryptFile($source, $dest, $key, $start, $iv); |
||
| 163 | if ($recursive) { |
||
| 164 | $this->encrypt_file($source, $dest, $key, $start, ($iv), $verification, $recursive); |
||
| 165 | } else { |
||
| 166 | |||
| 167 | if (($iv) != base64_decode(base64_encode($iv))) |
||
| 168 | { |
||
| 169 | throw new \Exception('Could not encode IV for transport'); |
||
| 170 | } |
||
| 171 | |||
| 172 | return array( |
||
| 173 | "start" => $start, |
||
| 174 | "iv" => base64_encode($iv), |
||
| 175 | "target_file" => $dest, |
||
| 176 | "finished" => 0 |
||
| 177 | ); |
||
| 178 | } |
||
| 179 | } |
||
| 180 | |||
| 181 | } |
||
| 182 | } else { |
||
| 183 | if (is_object($this->logger)) { |
||
| 184 | $this->logger->error('Unable to read source file for encryption.'); |
||
| 185 | } |
||
| 186 | throw new \Exception("Unable to read source file for encryption."); |
||
| 187 | } |
||
| 188 | } else { |
||
| 189 | if (is_object($this->logger)) { |
||
| 190 | $this->logger->error('Unable to write destination file for encryption.'); |
||
| 191 | } |
||
| 192 | throw new \Exception("Unable to write destination file for encryption."); |
||
| 193 | } |
||
| 194 | |||
| 195 | if ($verification) { |
||
| 196 | $this->verify_encrypted_file($dest); |
||
| 197 | } |
||
| 198 | |||
| 199 | //we replace the original backup with the encrypted one |
||
| 200 | if (!$keep_local && copy($this->get_xcloner_path().$dest, |
||
| 201 | $this->get_xcloner_path().$source)) { |
||
| 202 | unlink($this->get_xcloner_path().$dest); |
||
| 203 | } |
||
| 204 | |||
| 205 | |||
| 206 | return array("target_file" => $dest, "finished" => 1); |
||
| 207 | } |
||
| 208 | |||
| 209 | /** |
||
| 210 | * @param string $file |
||
| 211 | */ |
||
| 212 | public function verify_encrypted_file($file) { |
||
| 220 | } |
||
| 221 | |||
| 222 | /** |
||
| 223 | * Dencrypt the passed file and saves the result in a new file, removing the |
||
| 224 | * last 4 characters from file name. |
||
| 225 | * |
||
| 226 | * @param string $source Path to file that should be decrypted |
||
| 227 | * @param string $dest File name where the decryped file should be written to. |
||
| 228 | * @param string $key The key used for the decryption (must be the same as for encryption) |
||
| 229 | * @param int $start Start position for reading when doing incremental mode. |
||
| 230 | * @param integer $iv The IV key to use. |
||
| 231 | * @return string|false Returns the file name that has been created or FALSE if an error occured |
||
| 232 | */ |
||
| 233 | public function decrypt_file($source, $dest = "", $key = "", $start = 0, $iv = 0, $recursive = false) |
||
| 350 | } |
||
| 351 | |||
| 352 | public function get_xcloner_path() { |
||
| 358 | } |
||
| 359 | |||
| 360 | } |
||
| 361 | |||
| 383 |
Loading history...