GEANT /
CAT
Complex classes like WindowsCommon 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 WindowsCommon, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 27 | class WindowsCommon extends \core\DeviceConfig { |
||
| 28 | |||
| 29 | public function copyBasicFiles() { |
||
| 30 | if (!($this->copyFile('wlan_test.exe') && |
||
| 31 | $this->copyFile('check_wired.cmd') && |
||
| 32 | $this->copyFile('install_wired.cmd') && |
||
| 33 | $this->copyFile('cat_bg.bmp') && |
||
| 34 | $this->copyFile('base64.nsh'))) { |
||
| 35 | throw new Exception("Copying needed files (part 1) failed for at least one file!"); |
||
| 36 | } |
||
| 37 | |||
| 38 | if (!($this->copyFile('cat32.ico') && |
||
| 39 | $this->copyFile('cat_150.bmp') && |
||
| 40 | $this->copyFile('WLANSetEAPUserData/WLANSetEAPUserData32.exe', 'WLANSetEAPUserData32.exe') && |
||
| 41 | $this->copyFile('WLANSetEAPUserData/WLANSetEAPUserData64.exe', 'WLANSetEAPUserData64.exe'))) { |
||
| 42 | throw new Exception("Copying needed files (part 2) failed for at least one file!"); |
||
| 43 | } |
||
| 44 | if (!$this->translateFile('common.inc', 'common.nsh', $this->codePage)) { |
||
| 45 | throw new Exception("Translating needed file common.inc failed!"); |
||
| 46 | } |
||
| 47 | return; |
||
| 48 | } |
||
| 49 | |||
| 50 | public function copyPwdFiles() { |
||
| 51 | if (!($this->copyFile('Aruba_Networks_EAP-pwd_x32.msi') && |
||
| 52 | $this->copyFile('Aruba_Networks_EAP-pwd_x64.msi'))) { |
||
| 53 | throw new Exception("Copying needed files (EAP-pwd) failed for at least one file!"); |
||
| 54 | } |
||
| 55 | if (!$this->translateFile('pwd.inc', 'cat.NSI', $this->codePage)) { |
||
| 56 | throw new Exception("Translating needed file pwd.inc failed!"); |
||
| 57 | } |
||
| 58 | } |
||
| 59 | |||
| 60 | public function copyGeantLinkFiles() { |
||
| 61 | if (!($this->copyFile('GEANTLink/GEANTLink32.msi', 'GEANTLink32.msi') && |
||
| 62 | $this->copyFile('GEANTLink/GEANTLink64.msi', 'GEANTLink64.msi') && |
||
| 63 | $this->copyFile('GEANTLink/CredWrite.exe', 'CredWrite.exe') && |
||
| 64 | $this->copyFile('GEANTLink/MsiUseFeature.exe', 'MsiUseFeature.exe'))) { |
||
| 65 | throw new Exception("Copying needed files (GEANTLink) failed for at least one file!"); |
||
| 66 | } |
||
| 67 | if (!$this->translateFile('geant_link.inc', 'cat.NSI', $this->codePage)) { |
||
| 68 | throw new Exception("Translating needed file geant_link.inc failed!"); |
||
| 69 | } |
||
| 70 | } |
||
| 71 | |||
| 72 | |||
| 73 | /** |
||
| 74 | * function to escape double quotes in a special NSI-compatible way |
||
| 75 | * |
||
| 76 | * @param string $in input string |
||
| 77 | * @return string |
||
| 78 | */ |
||
| 79 | public static function echo_nsi($in) { |
||
| 80 | echo preg_replace('/"/', '$\"', $in); |
||
| 81 | } |
||
| 82 | |||
| 83 | /** |
||
| 84 | * @param string $input input string |
||
| 85 | * @return string |
||
| 86 | */ |
||
| 87 | public static function sprint_nsi($input) { |
||
| 88 | return preg_replace('/"/', '$\"', $input); |
||
| 89 | } |
||
| 90 | |||
| 91 | public function __construct() { |
||
| 92 | parent::__construct(); |
||
| 93 | $this->useGeantLink = ( isset($this->options['args']) && $this->options['args'] == 'gl' ) ? 1 : 0; |
||
| 94 | } |
||
| 95 | |||
| 96 | protected function prepareInstallerLang() { |
||
| 106 | |||
| 107 | public function writeDeviceInfo() { |
||
| 108 | $ssidCount = count($this->attributes['internal:SSID']); |
||
| 109 | $out = "<p>"; |
||
| 110 | $out .= sprintf(_("%s installer will be in the form of an EXE file. It will configure %s on your device, by creating wireless network profiles.<p>When you click the download button, the installer will be saved by your browser. Copy it to the machine you want to configure and execute."), CONFIG_CONFASSISTANT['CONSORTIUM']['display_name'], CONFIG_CONFASSISTANT['CONSORTIUM']['display_name']); |
||
| 111 | $out .= "<p>"; |
||
| 112 | if ($ssidCount > 1) { |
||
| 156 | |||
| 157 | protected function combineLogo($logos, $fedLogo = NULL) { |
||
| 216 | |||
| 217 | protected function signInstaller() { |
||
| 230 | |||
| 231 | protected function compileNSIS() { |
||
| 241 | |||
| 242 | protected function msInfoFile($attr) { |
||
| 269 | |||
| 270 | protected function writeAdditionalDeletes($profiles) { |
||
| 281 | |||
| 282 | protected function writeClientP12File() { |
||
| 290 | |||
| 291 | protected function writeTlsUserProfile() { |
||
| 294 | |||
| 295 | public $LANGS = [ |
||
| 296 | 'fr' => ['nsis' => "French", 'cp' => '1252'], |
||
| 297 | 'de' => ['nsis' => "German", 'cp' => '1252'], |
||
| 298 | 'es' => ['nsis' => "SpanishInternational", 'cp' => '1252'], |
||
| 299 | 'it' => ['nsis' => "Italian", 'cp' => '1252'], |
||
| 300 | 'nl' => ['nsis' => "Dutch", 'cp' => '1252'], |
||
| 301 | 'sv' => ['nsis' => "Swedish", 'cp' => '1252'], |
||
| 302 | 'fi' => ['nsis' => "Finnish", 'cp' => '1252'], |
||
| 303 | 'pl' => ['nsis' => "Polish", 'cp' => '1250'], |
||
| 304 | 'ca' => ['nsis' => "Catalan", 'cp' => '1252'], |
||
| 305 | 'sr' => ['nsis' => "SerbianLatin", 'cp' => '1250'], |
||
| 306 | 'hr' => ['nsis' => "Croatian", 'cp' => '1250'], |
||
| 307 | 'sl' => ['nsis' => "Slovenian", 'cp' => '1250'], |
||
| 308 | 'da' => ['nsis' => "Danish", 'cp' => '1252'], |
||
| 309 | 'nb' => ['nsis' => "Norwegian", 'cp' => '1252'], |
||
| 310 | 'nn' => ['nsis' => "NorwegianNynorsk", 'cp' => '1252'], |
||
| 311 | 'el' => ['nsis' => "Greek", 'cp' => '1253'], |
||
| 312 | 'ru' => ['nsis' => "Russian", 'cp' => '1251'], |
||
| 313 | 'pt' => ['nsis' => "Portuguese", 'cp' => '1252'], |
||
| 314 | 'uk' => ['nsis' => "Ukrainian", 'cp' => '1251'], |
||
| 315 | 'cs' => ['nsis' => "Czech", 'cp' => '1250'], |
||
| 316 | 'sk' => ['nsis' => "Slovak", 'cp' => '1250'], |
||
| 317 | 'bg' => ['nsis' => "Bulgarian", 'cp' => '1251'], |
||
| 318 | 'hu' => ['nsis' => "Hungarian", 'cp' => '1250'], |
||
| 319 | 'ro' => ['nsis' => "Romanian", 'cp' => '1250'], |
||
| 320 | 'lv' => ['nsis' => "Latvian", 'cp' => '1257'], |
||
| 321 | 'mk' => ['nsis' => "Macedonian", 'cp' => '1251'], |
||
| 322 | 'et' => ['nsis' => "Estonian", 'cp' => '1257'], |
||
| 323 | 'tr' => ['nsis' => "Turkish", 'cp' => '1254'], |
||
| 324 | 'lt' => ['nsis' => "Lithuanian", 'cp' => '1257'], |
||
| 325 | 'ar' => ['nsis' => "Arabic", 'cp' => '1256'], |
||
| 326 | 'he' => ['nsis' => "Hebrew", 'cp' => '1255'], |
||
| 327 | 'id' => ['nsis' => "Indonesian", 'cp' => '1252'], |
||
| 328 | 'mn' => ['nsis' => "Mongolian", 'cp' => '1251'], |
||
| 329 | 'sq' => ['nsis' => "Albanian", 'cp' => '1252'], |
||
| 330 | 'br' => ['nsis' => "Breton", 'cp' => '1252'], |
||
| 331 | 'be' => ['nsis' => "Belarusian", 'cp' => '1251'], |
||
| 332 | 'is' => ['nsis' => "Icelandic", 'cp' => '1252'], |
||
| 333 | 'ms' => ['nsis' => "Malay", 'cp' => '1252'], |
||
| 334 | 'bs' => ['nsis' => "Bosnian", 'cp' => '1250'], |
||
| 335 | 'ga' => ['nsis' => "Irish", 'cp' => '1250'], |
||
| 336 | 'uz' => ['nsis' => "Uzbek", 'cp' => '1251'], |
||
| 337 | 'gl' => ['nsis' => "Galician", 'cp' => '1252'], |
||
| 338 | 'af' => ['nsis' => "Afrikaans", 'cp' => '1252'], |
||
| 339 | 'ast' => ['nsis' => "Asturian", 'cp' => '1252'], |
||
| 340 | ]; |
||
| 341 | public $codePage; |
||
| 342 | public $lang; |
||
| 343 | public $useGeantLink; |
||
| 344 | |||
| 345 | } |
||
| 346 |
Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.
The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.
This check looks for comments that seem to be mostly valid code and reports them.