devices\ms\WindowsCommon

Complexity

Total Complexity

74

Size/Duplication

Total Lines	364
Duplicated Lines	0 %

Importance

Changes

0

18 Methods

Rating	Name	Duplication	Size	Complexity
C	writeDeviceInfo()	0	33	7
A	copyPwdFiles()	0	7	4
A	prepareInstallerLang()	0	8	2
A	echo_nsi()	0	2	1
A	sprint_nsi()	0	2	1
A	__construct()	0	3	3
B	copyBasicFiles()	0	19	11
B	copyGeantLinkFiles()	0	9	6
A	writeClientP12File()	0	5	2
A	writeTlsUserProfile()	0	1	1
B	combineLogo()	0	42	6
C	writeNsisDefines()	0	38	8
C	msInfoFile()	0	29	8
A	getSupport()	0	9	2
A	scaleLogo()	0	18	3
A	signInstaller()	0	12	3
A	compileNSIS()	0	9	2
A	writeAdditionalDeletes()	0	13	4

<?php
/*
 * ******************************************************************************
 * Copyright 2011-2017 DANTE Ltd. and GÉANT on behalf of the GN3, GN3+, GN4-1 
 * and GN4-2 consortia
 *
 * License: see the web/copyright.php file in the file structure
 * ******************************************************************************
 */

/**
 * This file contains common functions needed by all Windows installers
 * @author Tomasz Wolniewicz <twoln@umk.pl>
 *
 * @package ModuleWriting
 */

namespace devices\ms;
use \Exception;

/**
 * This class defines common functions needed by all Windows installers
 * @author Tomasz Wolniewicz <twoln@umk.pl>
 *
 * @package ModuleWriting
 */
abstract class WindowsCommon extends \core\DeviceConfig {

    public function copyBasicFiles() {
        if (!($this->copyFile('wlan_test.exe') &&
                $this->copyFile('check_wired.cmd') &&
                $this->copyFile('install_wired.cmd') &&
                $this->copyFile('cat_bg.bmp') &&
                $this->copyFile('base64.nsh'))) {
            throw new Exception("Copying needed files (part 1) failed for at least one file!");
        }

        if (!($this->copyFile('cat32.ico') &&
                $this->copyFile('cat_150.bmp') &&
                $this->copyFile('WLANSetEAPUserData/WLANSetEAPUserData32.exe', 'WLANSetEAPUserData32.exe') &&
                $this->copyFile('WLANSetEAPUserData/WLANSetEAPUserData64.exe', 'WLANSetEAPUserData64.exe'))) {
            throw new Exception("Copying needed files (part 2) failed for at least one file!");
        }
        if (!$this->translateFile('common.inc', 'common.nsh', $this->codePage)) {
            throw new Exception("Translating needed file common.inc failed!");
        }
        return;
    }

    public function copyPwdFiles() {
        if (!($this->copyFile('Aruba_Networks_EAP-pwd_x32.msi') &&
                $this->copyFile('Aruba_Networks_EAP-pwd_x64.msi'))) {
            throw new Exception("Copying needed files (EAP-pwd) failed for at least one file!");
        }
        if (!$this->translateFile('pwd.inc', 'cat.NSI', $this->codePage)) {
            throw new Exception("Translating needed file pwd.inc failed!");
        }
    }

    public function copyGeantLinkFiles() {
        if (!($this->copyFile('GEANTLink/GEANTLink32.msi', 'GEANTLink32.msi') &&
                $this->copyFile('GEANTLink/GEANTLink64.msi', 'GEANTLink64.msi') &&
                $this->copyFile('GEANTLink/CredWrite.exe', 'CredWrite.exe') &&
                $this->copyFile('GEANTLink/MsiUseFeature.exe', 'MsiUseFeature.exe'))) {
            throw new Exception("Copying needed files (GEANTLink) failed for at least one file!");
        }
        if (!$this->translateFile('geant_link.inc', 'cat.NSI', $this->codePage)) {
            throw new Exception("Translating needed file geant_link.inc failed!");
        }
    }


    /**
     * function to escape double quotes in a special NSI-compatible way
     * 
     * @param string $in input string
     * @return string
     */
    public static function echo_nsi($in) {
        echo preg_replace('/"/', '$\"', $in);
    }

    /**
     * @param string $input input string
     * @return string
     */
    public static function sprint_nsi($input) {
        return preg_replace('/"/', '$\"', $input);
    }

    public function __construct() {
        parent::__construct();
        $this->useGeantLink = (isset($this->options['args']) && $this->options['args'] == 'gl') ? 1 : 0;
    }

    protected function prepareInstallerLang() {
        if (isset($this->LANGS[$this->languageInstance->getLang()])) {
            $language = $this->LANGS[$this->languageInstance->getLang()];
            $this->lang = $language['nsis'];
            $this->codePage = 'cp' . $language['cp'];
        } else {
            $this->lang = 'English';
            $this->codePage = 'cp1252';
        }
    }

    public function writeDeviceInfo() {
        $ssids = $this->getAttibute('internal:SSID');
        $ssidCount = count($ssids);
        $out = "<p>";
        $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']);
        $out .= "<p>";
        if ($ssidCount > 1) {
            if ($ssidCount > 2) {
                $out .= sprintf(_("In addition to <strong>%s</strong> the installer will also configure access to the following networks:"), implode(', ', CONFIG_CONFASSISTANT['CONSORTIUM']['ssid'])) . " ";
            } else {
                $out .= sprintf(_("In addition to <strong>%s</strong> the installer will also configure access to:"), implode(', ', CONFIG_CONFASSISTANT['CONSORTIUM']['ssid'])) . " ";
            }
            $out .= '<strong>' . join('</strong>, <strong>', array_diff(array_keys($ssids), CONFIG_CONFASSISTANT['CONSORTIUM']['ssid'])) . '</strong>';
            $out .= "<p>";
        }
// TODO - change this below
        if ($this->selectedEapObject->isClientCertRequired()) {
            $out .= sprintf(_("In order to connect to the network you will need an a personal certificate in the form of a p12 file. You should obtain this certificate from your %s. Consult the support page to find out how this certificate can be obtained. Such certificate files are password protected. You should have both the file and the password available during the installation process."), $this->nomenclature_inst);
            return($out);
        }
        // not EAP-TLS
        $out .= sprintf(_("In order to connect to the network you will need an account from your %s. You should consult the support page to find out how this account can be obtained. It is very likely that your account is already activated."), $this->nomenclature_inst);

        if (!$this->useGeantLink && $this->selectedEap['OUTER'] == \core\common\EAP::TTLS) {
            $out .= "<p>";
            $out .= _("When you are connecting to the network for the first time, Windows will pop up a login box, where you should enter your user name and password. This information will be saved so that you will reconnect to the network automatically each time you are in the range.");
            if ($ssidCount > 1) {
                $out .= "<p>";
                $out .= _("You will be required to enter the same credentials for each of the configured notworks:") . " ";
                $out .= '<strong>' . join('</strong>, <strong>', array_keys($ssids)) . '</strong>';
            }
        }
        return($out);
    }    
    
    private function scaleLogo($imagePath, $maxSize) {
        $imageObject = new \Imagick($imagePath);
        $imageSize = $imageObject->getImageGeometry();
        $imageMax = max($imageSize);
        $this->loggerInstance->debug(5, "Logo size: ");
        $this->loggerInstance->debug(5, $imageSize);
        $this->loggerInstance->debug(5, "max=$imageMax\n");
// resize logo if necessary
        if ($imageMax > $maxSize) {
            if ($imageMax == $imageSize['width']) {
                $imageObject->scaleImage($maxSize, 0);
            } else {
                $imageObject->scaleImage(0, $maxSize);
            }
        }
        $imageSize = $imageObject->getImageGeometry();
        $this->background['freeHeight'] -= $imageSize['height'];
        return($imageObject);
    }

    protected function combineLogo($logos = NULL, $fedLogo = NULL) {
        // maximum size to which we want to resize the logos
        
        $maxSize = 120;
        // $freeTop is set to how much vertical space we need to leave at the top
        // this will depend on the design of the background
        $freeTop = 70;
        // $freeBottom is set to how much vertical space we need to leave at the bottom
        // this will depend on the design of the background
        $freeBottom = 30;
        
        $bgImage = new \Imagick('cat_bg.bmp');
        $bgImage->setFormat('BMP3');
        $bgImageSize = $bgImage->getImageGeometry();
        $logosToPlace = [];
        $this->background = [];
        $this->background['freeHeight'] = $bgImageSize['height'] - $freeTop - $freeBottom;

        if ($this->getAttibute('fed:include_logo_installers') === NULL) {
            $fedLogo = NULL;
        }
        if ($fedLogo != NULL) {
            $logosToPlace[] = $this->scaleLogo($fedLogo[0]['name'], $maxSize);
        }
        if ($logos != NULL) {
            $logosToPlace[] = $this->scaleLogo($logos[0]['name'], $maxSize);
        }

        $logoCount = count($logosToPlace);
        if ($logoCount > 0) {
            $voffset = $freeTop;
            $freeSpace = (int)round($this->background['freeHeight'] / ($logoCount + 1));
            foreach ($logosToPlace as $logo) {
                $voffset += $freeSpace;
                $logoSize = $logo->getImageGeometry();
                $hoffset = (int)round(($bgImageSize['width'] - $logoSize['width']) / 2);
                $bgImage->compositeImage($logo, $logo->getImageCompose(), $hoffset, $voffset);
                $voffset += $logoSize['height'];
                }
        }
//new image is saved as the background
        $bgImage->writeImage('BMP3:cat_bg.bmp');
    }

    protected function signInstaller() {
        $fileName = $this->installerBasename . '.exe';
        if (!$this->sign) {
            rename("installer.exe", $fileName);
            return $fileName;
        }
        // are actually signing
        $outputFromSigning = system($this->sign . " installer.exe '$fileName' > /dev/null");
        if ($outputFromSigning === FALSE) {
            $this->loggerInstance->debug(2, "Signing the WindowsCommon installer $fileName FAILED!\n");
        }
        return $fileName;
    }

    protected function compileNSIS() {
        if (CONFIG_CONFASSISTANT['NSIS_VERSION'] >= 3) {
            $makensis = CONFIG_CONFASSISTANT['PATHS']['makensis'] . " -INPUTCHARSET UTF8";
        } else {
            $makensis = CONFIG_CONFASSISTANT['PATHS']['makensis'];
        }
        $command = $makensis . ' -V4 cat.NSI > nsis.log 2>&1';
        system($command);
        $this->loggerInstance->debug(4, "compileNSIS:$command\n");
    }

    private function getSupport($attr, $type) {
        $supportString = [
            'email' => 'SUPPORT',
            'url' => 'URL',
        ];
        $s = "support_" . $type . "_substitute";
        $substitute = $this->translateString($this->$s, $this->codePage);
        $returnValue = !empty($attr['support:' . $type][0]) ? $attr['support:' .  $type][0] : $substitute;
        return('!define ' . $supportString[$type] . ' "' . $returnValue . '"' . "\n");
    }
    
    
    protected function writeNsisDefines($attr) {
        $fcontents = "\n" . '!define NSIS_MAJOR_VERSION ' . CONFIG_CONFASSISTANT['NSIS_VERSION'];
        if ($attr['internal:profile_count'][0] > 1) {
            $fcontents .= "\n" . '!define USER_GROUP "' . $this->translateString(str_replace('"', '$\\"', $attr['profile:name'][0]), $this->codePage) . '"
';
        }
        $fcontents .=  '
Caption "' . $this->translateString(sprintf(WindowsCommon::sprint_nsi(_("%s installer for %s")), CONFIG_CONFASSISTANT['CONSORTIUM']['display_name'], $attr['general:instname'][0]), $this->codePage) . '"
!define APPLICATION "' . $this->translateString(sprintf(WindowsCommon::sprint_nsi(_("%s installer for %s")), CONFIG_CONFASSISTANT['CONSORTIUM']['display_name'], $attr['general:instname'][0]), $this->codePage) . '"
!define VERSION "' . \core\CAT::VERSION_MAJOR . '.' . \core\CAT::VERSION_MINOR . '"
!define INSTALLER_NAME "installer.exe"
!define LANG "' . $this->lang . '"
!define LOCALE "' . preg_replace('/\..*$/', '', CONFIG['LANGUAGES'][$this->languageInstance->getLang()]['locale']) . '"
;--------------------------------
!define ORGANISATION "' . $this->translateString($attr['general:instname'][0], $this->codePage) . '"
';
        $fcontents .= $this->getSupport($attr, 'email');
        $fcontents .= $this->getSupport($attr, 'url');                
        if (\core\common\Entity::getAttributeValue($attr, 'media:wired', 0) == 'on') {
            $fcontents .= '!define WIRED
        ';
        }
        $fcontents .= '!define PROVIDERID "urn:UUID:' . $this->deviceUUID . '"
';
        if (!empty($attr['internal:realm'][0])) {
            $fcontents .= '!define REALM "' . $attr['internal:realm'][0] . '"
';
        }
        if(!empty($attr['internal:hint_userinput_suffix'][0]) && $attr['internal:hint_userinput_suffix'][0] == 1) {
            $fcontents .= '!define HINT_USER_INPUT "' . $attr['internal:hint_userinput_suffix'][0] . '"
';
        }
        if(!empty($attr['internal:verify_userinput_suffix'][0]) && $attr['internal:verify_userinput_suffix'][0] == 1) {
            $fcontents .= '!define VERIFY_USER_REALM_INPUT "' . $attr['internal:verify_userinput_suffix'][0] . '"
';
        }
        $fcontents .= $this->msInfoFile($attr);
        return($fcontents);
           
    }
    
    protected function msInfoFile($attr) {
        $out = '';
        if (isset($attr['support:info_file'])) {
            $out .= '!define EXTERNAL_INFO "';
//  $this->loggerInstance->debug(4,"Info file type ".$attr['support:info_file'][0]['mime']."\n");
            if ($attr['internal:info_file'][0]['mime'] == 'rtf') {
                $out = '!define LICENSE_FILE "' . $attr['internal:info_file'][0]['name'];
            } elseif ($attr['internal:info_file'][0]['mime'] == 'txt') {
                $infoFile = file_get_contents($attr['internal:info_file'][0]['name']);
                if ($infoFile === FALSE) {
                    throw new Exception("We were told this file exists. Failing to read it is not really possible.");
                }
                if (CONFIG_CONFASSISTANT['NSIS_VERSION'] >= 3) {
                    $infoFileConverted = $infoFile;
                } else {
                    $infoFileConverted = iconv('UTF-8', $this->codePage . '//TRANSLIT', $infoFile);
                }
                if ($infoFileConverted !== FALSE && strlen($infoFileConverted) > 0) {
                    file_put_contents('info_f.txt', $infoFileConverted);
                    $out = '!define LICENSE_FILE " info_f.txt';
                }
            } else {
                $out = '!define EXTERNAL_INFO "' . $attr['internal:info_file'][0]['name'];
            }

            $out .= "\"\n";
        }
        $this->loggerInstance->debug(4, "Info file returned: $out");
        return $out;
    }

    protected function writeAdditionalDeletes($profiles) {
        if (count($profiles) == 0) {
            return;
        }
        $fileHandle = fopen('profiles.nsh', 'a');
        if ($fileHandle === FALSE) {
            throw new Exception("Unable to open possibly pre-existing profiles.nsh to append additional deletes.");
        }
        fwrite($fileHandle, "!define AdditionalDeletes\n");
        foreach ($profiles as $profile) {
            fwrite($fileHandle, "!insertmacro define_delete_profile \"$profile\"\n");
        }
        fclose($fileHandle);
    }

    protected function writeClientP12File() {
        if (!is_array($this->clientCert)) {
            throw new Exception("the client block was called but there is no client certificate!");
        }
        file_put_contents('SB_cert.p12', $this->clientCert["certdata"]);
    }

    protected function writeTlsUserProfile() {
        
    }

    public $LANGS = [
        'fr' => ['nsis' => "French", 'cp' => '1252'],
        'de' => ['nsis' => "German", 'cp' => '1252'],
        'es' => ['nsis' => "SpanishInternational", 'cp' => '1252'],
        'it' => ['nsis' => "Italian", 'cp' => '1252'],
        'nl' => ['nsis' => "Dutch", 'cp' => '1252'],
        'sv' => ['nsis' => "Swedish", 'cp' => '1252'],
        'fi' => ['nsis' => "Finnish", 'cp' => '1252'],
        'pl' => ['nsis' => "Polish", 'cp' => '1250'],
        'ca' => ['nsis' => "Catalan", 'cp' => '1252'],
        'sr' => ['nsis' => "SerbianLatin", 'cp' => '1250'],
        'hr' => ['nsis' => "Croatian", 'cp' => '1250'],
        'sl' => ['nsis' => "Slovenian", 'cp' => '1250'],
        'da' => ['nsis' => "Danish", 'cp' => '1252'],
        'nb' => ['nsis' => "Norwegian", 'cp' => '1252'],
        'nn' => ['nsis' => "NorwegianNynorsk", 'cp' => '1252'],
        'el' => ['nsis' => "Greek", 'cp' => '1253'],
        'ru' => ['nsis' => "Russian", 'cp' => '1251'],
        'pt' => ['nsis' => "Portuguese", 'cp' => '1252'],
        'uk' => ['nsis' => "Ukrainian", 'cp' => '1251'],
        'cs' => ['nsis' => "Czech", 'cp' => '1250'],
        'sk' => ['nsis' => "Slovak", 'cp' => '1250'],
        'bg' => ['nsis' => "Bulgarian", 'cp' => '1251'],
        'hu' => ['nsis' => "Hungarian", 'cp' => '1250'],
        'ro' => ['nsis' => "Romanian", 'cp' => '1250'],
        'lv' => ['nsis' => "Latvian", 'cp' => '1257'],
        'mk' => ['nsis' => "Macedonian", 'cp' => '1251'],
        'et' => ['nsis' => "Estonian", 'cp' => '1257'],
        'tr' => ['nsis' => "Turkish", 'cp' => '1254'],
        'lt' => ['nsis' => "Lithuanian", 'cp' => '1257'],
        'ar' => ['nsis' => "Arabic", 'cp' => '1256'],
        'he' => ['nsis' => "Hebrew", 'cp' => '1255'],
        'id' => ['nsis' => "Indonesian", 'cp' => '1252'],
        'mn' => ['nsis' => "Mongolian", 'cp' => '1251'],
        'sq' => ['nsis' => "Albanian", 'cp' => '1252'],
        'br' => ['nsis' => "Breton", 'cp' => '1252'],
        'be' => ['nsis' => "Belarusian", 'cp' => '1251'],
        'is' => ['nsis' => "Icelandic", 'cp' => '1252'],
        'ms' => ['nsis' => "Malay", 'cp' => '1252'],
        'bs' => ['nsis' => "Bosnian", 'cp' => '1250'],
        'ga' => ['nsis' => "Irish", 'cp' => '1250'],
        'uz' => ['nsis' => "Uzbek", 'cp' => '1251'],
        'gl' => ['nsis' => "Galician", 'cp' => '1252'],
        'af' => ['nsis' => "Afrikaans", 'cp' => '1252'],
        'ast' => ['nsis' => "Asturian", 'cp' => '1252'],
    ];
    public $codePage;
    public $lang;
    public $useGeantLink;
    private $background;

}